{ "x-generator": "NSwag v13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "Citrix Virtual Apps and Desktops Rest API for Developer Portal", "version": "devportal-onprem-ga" }, "servers": [ { "url": "https://[DdcServerAddress]/cvad/manage", "description": "Use on-premises DDC server address" } ], "paths": { "/$batch": { "post": { "tags": [ "Batch APIs" ], "summary": "Perform a batch request.", "description": "Perform a batch request. This allows the client to submit more than one request\nat a time. The requests may be performed in parallel and may not have any\ndependencies between them. The result will be returned once all requests have\ncompleted.", "operationId": "Batch_DoBatchRequest", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the batch request will be processed as a background task.\nThis is recommended, since a batch request that takes more than\n90 seconds to execute may time out, and results may be lost.\nThe task will have JobType Batch.\nThe SubJobs will correspond to the\nitems in the batch request.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain no properties.\n ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "List of requests that the server should perform in parallel.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BatchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Batch response model. Responses may come in any order within\nthe response model, and should be correlated with requests via\nthe Reference property.\n ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BatchResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/$checkObjectNameExists": { "post": { "tags": [ "Sites APIs" ], "summary": "Check for the existence of an object.", "description": "If the name exists, this returns true; otherwise, it returns false.", "operationId": "Sites_CheckObjectNameExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "Details about the object to check.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CheckObjectNameExistsRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "True if the name is existed, false otherwise.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "Boolean", "type": "boolean" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/$GetHypervisor": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Get a hypervisor details without creating persistent connection.", "operationId": "Hypervisors_GetHypervisorWithoutConnection", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "Async request to get the hypervisor. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "connectionDetail", "description": "Details of how to connect to the hypervisor to enumerate resources from it.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorDetailResponseModel" } } }, "x-expectedSchemas": [ { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAWSResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAzureResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailGCPResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailWOLResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailTraditionalResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOciResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOracleC3ResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAzureArcResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOpenShiftResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAWCResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailNutanixPCResponseModel" } }, { "description": "HypervisorDetailResponseModel derived hypervisor instance. ", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/$selectall": { "post": { "tags": [ "Batch APIs" ], "summary": "Handles a select-all request, retrieving all relevant data based on the input parameters.", "description": "Perform a select-all request. This allows the client to execute an action for all\nselected items. The result will be returned once all items' action have\ncompleted.", "operationId": "Batch_DoSelectAllRequest", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the batch request will be processed as a background task.\nThis is recommended, since a batch request that takes more than\n90 seconds to execute may time out, and results may be lost.\nThe task will have JobType Batch.\nThe SubJobs will correspond to the\nitems in the batch request.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain no properties.\n ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "requestBody": { "x-name": "request", "description": "The select-all request model containing the query parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SelectAllRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "A SelectAllResponseModel containing the results of the select-all operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SelectAllResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/About": { "get": { "tags": [ "About APIs" ], "summary": "Get About info of this Orchestration instance.", "operationId": "About_GetAbout", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "About info.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AboutModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Administrators": { "get": { "tags": [ "Admin APIs" ], "summary": "Get administrators.", "description": "Get administrators in the site.", "operationId": "Admin_GetAdminAdministrators", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of administrators returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the administrators will be fetched as a background task.\nThe task will have the JobTypeGetAdminAdministrators", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Collection of administrators in the site.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministratorResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Admin APIs" ], "summary": "Create a new administrator.", "description": "Create a new administrator.\n \nAdministrator objects are used to determine what rights, and\ntherefore what permissions a particular user has through the various\nSDKs and consoles of the site.\n \nWhen the Enabled flag of an administrator is set to `false`, any\nrights of the administrator are ignored by the system when\nperforming permission checks.", "operationId": "Admin_CreateAdminAdministrator", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the admin will be created as a background task. The task\nwill have JobType CreateAdmin. When the task", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the admin to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateAdminAdministratorRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Administrators/$PreviewReport": { "post": { "tags": [ "Admin APIs" ], "summary": "Get preview report of the administrator.", "operationId": "Admin_PreviewAdministratorReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "The administrator creation request to preview.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateAdminAdministratorRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorReportResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Administrators/{name}/NamePreview": { "get": { "tags": [ "Admin APIs" ], "summary": "Get preview report of the administrator user name.", "operationId": "Admin_GetAdministratorNamePreview", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Example: domain\\username or domain\\group", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "ignoreFormatCheck", "in": "query", "description": "Ignore name format check. If true,\n will only check whether AD account available and not conflicting to existing administrators.\n Note, invalid name will still be reported, only report error message will be changed.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorNamePreviewResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Administrators/{nameOrId}": { "delete": { "tags": [ "Admin APIs" ], "summary": "Delete an administrator.", "operationId": "Admin_DeleteAdminAdministrator", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or Id of the admin to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the admin will be deleted as a background task.\nThe task will have JobType DeleteAdmin.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Admin APIs" ], "summary": "Get a single administrator", "operationId": "Admin_GetAdminAdministrator", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or id of the administrator.\n May be specified as:\n \n * The SID of the admin user or group. Note: in directory types\n other than Active Directory, the SID is a\n computed property, and is not related to any representation of that\n user within Active Directory. However it can still be useful if the\n user already has a generated SID; for example, if copying users from\n one object to another.\n \n * `Domain\\User` format. This implies the directory type\n Active Directory. If the Domain\\User is not\n unique across AD Forests, the call will fail with an ambiguous name\n error, status code 400.\n \n * `Forest\\Domain\\User` format. This implies the directory type\n Active Directory. This is the preferred form\n of specifying an Active Directory user by name, as the name is\n guaranteed to be unambiguous.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Response Model of this administrator.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministratorResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Admin APIs" ], "summary": "Update an administrator.", "description": "Update an administrator.", "operationId": "Admin_UpdateAdminAdministrator", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name of the admin to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the admin will be updated as a background task. The task\nwill have JobType UpdateAdmin. When the task", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Updated details of the admin.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateAdminAdministratorRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Administrators/{nameOrId}/PreviewDeleteConsequence": { "get": { "tags": [ "Admin APIs" ], "summary": "Preview the consequence of deleting an administrator.", "operationId": "Admin_GetDeleteAdministratorConsequence", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or Id of the admin to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorDeleteConcequenceResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Administrators/{nameOrId}/Report": { "get": { "tags": [ "Admin APIs" ], "summary": "Get report of the administrator.", "operationId": "Admin_GetAdministratorReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or Id of the admin to report.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorReportResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/EffectiveRights": { "get": { "tags": [ "Admin APIs" ], "summary": "Get the effective rights of the current user. This is the union of\nall rights of the enabled administrators that the current user matches,\ntaking into account group membership.", "operationId": "Admin_GetAdminEffectiveRights", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "description": "Optional ETag response header that was returned on the previous query.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of admin rights returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of admin rights.", "headers": { "ETag": { "description": "A value that is guaranteed to change if the entity may change.", "schema": { "type": "string" }, "example": "{current etag}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministratorRightResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/PermissionGroups": { "get": { "tags": [ "Admin APIs" ], "summary": "Get all permission groups.", "description": "Get all permission groups.\n \nPermission groups are primarily used to store the localized name for\na group of permissions.", "operationId": "Admin_GetPredefinedPermissionGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of predefined permission groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of permission groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PredefinedPermissionGroupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/PermissionGroups/{id}/Permissions": { "get": { "tags": [ "Admin APIs" ], "summary": "Get all permissions for a permission group.", "description": "Get all permissions for a permission group.\n \nPermission groups are primarily used to store the localized name for\na group of permissions.", "operationId": "Admin_GetPredefinedPermissionsForGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the admin permission group to query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of predefined permissions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "The list of permissions in a permission group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PredefinedPermissionResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Permissions": { "get": { "tags": [ "Admin APIs" ], "summary": "Get all predefined permissions.", "operationId": "Admin_GetPredefinedPermissions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of predefined permissions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of predefined permissions.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedPermissionResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Roles": { "get": { "tags": [ "Admin APIs" ], "summary": "Get admin roles.", "description": "Gets all the admin roles defined in the site.", "operationId": "Admin_GetAdminRoles", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of admin roles returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of admin roles.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Admin APIs" ], "summary": "Create a new admin role.", "description": "Create a new custom admin role. Roles represent a job function,\nsuch as 'help desk administrator', and contain a list of permissions\nthat are required to perform that job function.\n \nRoles and Scopes combine when assigned to admin, defining the Rights\nthat the admin has within the site.", "operationId": "Admin_CreateAdminRole", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the admin role will be created as a background task. The\ntask will have JobType CreateAdminRole. When\nthe task is complete it will redirect to\nGetAdminRole.\nThe job Parameters will contain properties:\n \n* _Name_ - Name of the admin role being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the admin role to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateAdminRoleRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Roles/{name}": { "head": { "tags": [ "Admin APIs" ], "summary": "Check for the existence of role by name.", "description": "If the name is found to be available, this returns 404 Not Found. If the name\nis not available (i.e. an application group with the name was found), this\nreturns 204 No Content.", "operationId": "Admin_CheckRoleNameExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the role.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Roles/{nameOrId}": { "delete": { "tags": [ "Admin APIs" ], "summary": "Delete an admin role.", "description": "Delete an admin role.\n \nYou cannot remove built-in roles.\n \nAn error will be produced if the role being removed is currently\nassigned to an administrator unless you specify the `force` query\nparameter. When `force` is specified, any rights that reference the\nrole are also removed.", "operationId": "Admin_DeleteAdminRole", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the admin role to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "force", "in": "query", "description": "Allow removal of roles that are still in use.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the admin role will be deleted as a background task. The\ntask will have JobType DeleteAdminRole. When\n* _NameOrId_ - Name or ID of the admin role being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Admin APIs" ], "summary": "Get details about a single admin role.", "description": "Gets the details for a single admin role within the site.", "operationId": "Admin_GetAdminRole", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the admin role.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The admin role details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Admin APIs" ], "summary": "Update an admin role.", "description": "Update an admin role. An admin role is a collection of permissions,\ntypically enabling an admin persona. For example an admin may need\nto both read and control sessions in order to perform a help desk\nfunction.\nRoles and Scopes combine when assigned to admin, defining the Rights\nthat the admin has within the site.\n\nYou cannot modify built-in roles.", "operationId": "Admin_UpdateAdminRole", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the admin role to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the admin scope will be updated as a background task.\nThe task will have JobType UpdateAdminRole.\nWhen the task is complete it will redirect to\nGetAdminRole.\nThe job Parameters will contain properties:\n* _NameOrId_ - Name or ID of the admin role being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Updated details of the admin role.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditAdminRoleRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Scopes": { "get": { "tags": [ "Admin APIs" ], "summary": "Get admin scopes.", "description": "Gets all the admin scopes defined in the site.", "operationId": "Admin_GetAdminScopes", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of admin scopes returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of admin scopes.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopeResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Admin APIs" ], "summary": "Create a new admin scope.", "description": "A scope represents a collection of objects. Scopes are used to\n group objects in a way that is relevant to the organization; for\n example, the set of delivery groups used by the Sales team.\n \n To assign a scope to an administrator, combine it with a role and\n then assign this pair (also known as a 'right') to an administrator.", "operationId": "Admin_CreateAdminScope", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the admin scope will be created as a background task.\nThe task will have JobType CreateAdminScope.\nWhen the task is complete it will redirect to\nGetAdminScopes.\nThe job Parameters will contain properties:\n \n* _Name_ - Name of the admin scope being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the admin scope to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateAdminScopeRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Scopes/{name}": { "head": { "tags": [ "Admin APIs" ], "summary": "Check for the existence of scope by name.", "description": "If the name is found to be available, this returns 404 Not Found. If the name\nis not available (i.e. an application group with the name was found), this\nreturns 204 No Content.", "operationId": "Admin_CheckScopeNameExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the scope.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Scopes/{nameOrId}": { "delete": { "tags": [ "Admin APIs" ], "summary": "Delete an admin scope.", "description": "You cannot remove the built-in `All` scope.\n \nAn error will be produced if the scope being removed is currently\nassigned to an administrator unless you specify the `force` query\nparameter. When `force` is specified, any rights that reference the\nscope are also removed.", "operationId": "Admin_DeleteAdminScope", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the admin scope to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "force", "in": "query", "description": "Allow removal of scopes that are still in use.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the admin scope will be deleted as a background task.\nThe task will have JobType DeleteAdminScope.\nWhen the task is complete it will redirect to\nGetAdminScopes.\nThe job Parameters will contain properties:\n \n* _Name_ - Name of the admin scope being deleted.\n* _Id_ - ID of the admin scope being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Admin APIs" ], "summary": "Get details about a single admin scope.", "description": "Gets the details for a single admin scope within the site.", "operationId": "Admin_GetAdminScope", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the admin scope.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The admin scope details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopeResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Admin APIs" ], "summary": "Update an admin scope.", "description": "Update an admin scope. You cannot modify the built-in `All` scope.\n \nChanges to an admin scope apply to all admins to whom the scope is\nassigned.", "operationId": "Admin_UpdateAdminScope", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the admin scope to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the admin scope will be updated as a background task.\nThe task will have JobType UpdateAdminScope.\nWhen the task is complete it will redirect to\nGetAdminScope.\nThe job Parameters will contain properties:\n \n* _Name_ - Name of the admin scope being updated.\n* _Id_ - ID of the admin scope being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Updated details of the admin scope.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditAdminScopeRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Admin/Scopes/{nameOrId}/ScopedObjects": { "get": { "tags": [ "Admin APIs" ], "summary": "Get the objects in an admin scope.", "description": "Gets all objects in an admin scope.", "operationId": "Admin_GetAdminScopedObjects", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the admin scope.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of objects returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of scoped objects.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopedObjectResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AdminFolders": { "get": { "tags": [ "AdminFolders APIs" ], "summary": "Get admin folders.", "description": "Gets all admin folders within the site.", "operationId": "AdminFolders_GetAdminFolders", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the admin folders will be fetched as a background task.\nThe task will have JobType GetAdminFolders.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of admin folders returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of admin folders.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFolderResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "AdminFolders APIs" ], "summary": "Create an admin folder", "description": "Create an admin folder.", "operationId": "AdminFolders_CreateAdminFolder", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the admin folder will be created as a background task.\nThe task will have JobType \"JobType.CreateAdminFolder\".\nWhen the task is complete it will redirect to\n\"GetAdminFolder(string)\"\nThe job Parameters will contain properties:\n\n* _Name_ - Name of the folder being created.\n* _Path_ - Path to the folder being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the admin folder to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateAdminFolderRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFolderResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AdminFolders/{pathOrId}": { "delete": { "tags": [ "AdminFolders APIs" ], "summary": "Delete an admin folder.", "description": "Delete an admin folder. An admin folder is not allowed to be deleted\nwhen it contains any objects.", "operationId": "AdminFolders_DeleteAdminFolder", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Name or ID of the admin folder to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "objectsToRemove", "in": "query", "style": "form", "explode": true, "description": "Identify which object should be removed from the adminFolder.\nIf set to null, then the admin folder will be deleted if it hosts no object\nand no folder metaData with keys AdminFolderObjectIdentifier.\n \nIf set to Applications, the applications in the folder will be deleted. The folder\nwill be deleted if it do not host other objects(MachineCatalogs, or DeliveryGroup,\nor ApplicationGroups) and no folder metaData with keysAdminFolderObjectIdentifier.;\nIf the folder hosts any other objects, then this folder will not be deleted,\nfolder metadata with key ContainsApplications will be removed.\n \nIf set to MachineCatalogs and this folder still hosts some MachineCatalogs, then\nthis folder is not allowed to be deleted; If this folder do not host any MachineCatalogs\nbut host other objects(Applications, DeliveryGroups, ApplicationGroups), the folder\nmetaData with key ContainsMachineCatalogs\nwill be removed; If this folder do not host any objects and no folder metaData with\nkeys AdminFolderObjectIdentifier, the folder will be deleted.\n \nIf set to DeliveryGroups or ApplicationGroups, have the same behavior as set to MachineCatalogs.", "schema": { "title": "AdminFolderObjects[]", "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/AdminFolderObjects" } }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the admin folder will be deleted as a background task.\nThe task will have JobType DeleteAdminFolder.\nWhen the task is complete it will redirect to GetAdminFolders.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the admin folder being deleted,\n* _Path_ - Path of the admin folder being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "AdminFolders APIs" ], "summary": "Get details about a single admin folder.", "description": "Gets the details of a single admin folder.", "operationId": "AdminFolders_GetAdminFolder", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Path (URL-encoded) or ID of the admin folder.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Admin folder details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFolderResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "AdminFolders APIs" ], "summary": "Update an admin folder.", "description": "Update an admin folder's properties.", "operationId": "AdminFolders_UpdateAdminFolder", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Path or ID of the admin folder path to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the admin folder will be updated as a background task.\nThe task will have JobType UpdateAdminFolder.\nWhen the task is complete it will redirect to\nGetAdminFolder.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the admin folder being updated.\n* _Path_ - Path of the admin folder being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "folder", "description": "Details of the admin folder to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditAdminFolderRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The async job or the admin folder.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFolderResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AdminFolders/{pathOrId}/Applications": { "get": { "tags": [ "AdminFolders APIs" ], "summary": "Get the applications in an admin folder.", "description": "Get a list of all applications in an admin folder.", "operationId": "AdminFolders_GetAdminFolderApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Path (URL-encoded) or ID of the admin folder.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ApplicationFolder" }, { "name": "async", "in": "query", "description": "If `true`, Fetch applications under admin folder will be a background task.\nThe task will have JobType GetAdminFolderApplications", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of applications in the folder.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AdminFolders/{pathOrId}/MachineCatalogs": { "get": { "tags": [ "AdminFolders APIs" ], "summary": "Get the machineCatalogs in an admin folder.", "description": "Get a list of all machineCatalogs in an admin folder.", "operationId": "AdminFolders_GetAdminFolderMachineCatalogs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Path (URL-encoded) or ID of the admin folder.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of machine catalogs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 2147483647 }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Name,FullName,Id" }, { "name": "async", "in": "query", "description": "If `true`, Fetch machineCatalogs under admin folder will be a background task.\nThe task will have JobType GetAdminFolderMachineCatalogs", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of machineCatalogs in the folder.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCatalogResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Advisor/$cancelRecommendations": { "post": { "tags": [ "Advisor" ], "summary": "Cancel the advisor recommendations generation.", "operationId": "Advisor_CancelAdvisorRecommendations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Advisor/$dismissRecommendations": { "post": { "tags": [ "Advisor" ], "summary": "Dismiss advisor recommendations.", "operationId": "Advisor_DismissAdvisorRecommendations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "recommendations", "in": "query", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "dismissed", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Advisor/$generateRecommendations": { "post": { "tags": [ "Advisor" ], "summary": "Generate advisor recommendations.", "operationId": "Advisor_GenerateAdvisorRecommendations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdvisorRecommendationRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Advisor/Recommendations": { "delete": { "tags": [ "Advisor" ], "summary": "Delete advisor recommendations.", "operationId": "Advisor_DeleteAdvisorRecommendations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Advisor" ], "summary": "Get advisor recommendations.", "operationId": "Advisor_GetAdvisorRecommendations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "includeDismissed", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvisorRecommendationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Advisor/Recommendations/{recommendationId}": { "get": { "tags": [ "Advisor" ], "summary": "Get advisor recommendation.", "operationId": "Advisor_GetAdvisorRecommendation", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "recommendationId", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvisorRecommendationResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Advisor" ], "summary": "Patch advisor recommendation.", "operationId": "Advisor_PatchRecommendation", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "recommendationId", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditAdvisorRecommendationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvisorRecommendationResponseModel" } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Advisor/Recommendations/Settings": { "get": { "tags": [ "Advisor" ], "summary": "Get advisor settings.", "operationId": "Advisor_GetAdvisorSettings", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvisorSettingsResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Advisor/Recommendations/Settings/{ruleId}/{settingName}": { "put": { "tags": [ "Advisor" ], "summary": "Set a customized value for a specific setting.", "operationId": "Advisor_SetSetting", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "ruleId", "in": "path", "required": true, "description": "The rule ID.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "settingName", "in": "path", "required": true, "description": "The setting name.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "value", "description": "The customized value.", "content": { "application/json": { "schema": { "title": "Object", "type": "object", "nullable": true } } }, "required": true, "x-position": 3 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Advisor/Recommendations/Settings/{ruleId}/{settingName}/$reset": { "post": { "tags": [ "Advisor" ], "summary": "Reset a setting to its default value.", "operationId": "Advisor_ResetSetting", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "ruleId", "in": "path", "required": true, "description": "The rule ID.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "settingName", "in": "path", "required": true, "description": "The setting name.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppLibPackageDiscovery/Profiles": { "get": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Get a list of AppLib Package Discovery profiles.", "operationId": "AppLibPackageDiscovery_GetAppLibPackageDiscoveryProfiles", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the appLib package discovery profiles will be fetched as a background task.\nThe task will have JobType GetAppLibPackageDiscoveryProfiles.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "A list of appLib package discovery profiles.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppLibPackageDiscoveryProfileResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Create an AppLib Package Discovery profile.", "operationId": "AppLibPackageDiscovery_CreateAppLibPackageDiscoveryProfile", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the appLib package discovery profile will be created as a background task.\nThe task will have JobType CreateAppLibPackageDiscoveryProfile.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Request model to create a new AppLib package discovery profile.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppLibPackageDiscoveryProfileRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppLibPackageDiscoveryProfileResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppLibPackageDiscovery/Profiles/{uid}": { "delete": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Remove an AppLib Package Discovery profile.", "operationId": "AppLibPackageDiscovery_RemoveAppLibPackageDiscoveryProfile", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "description": "Uid of the appLib package discovery profile that need to be removed.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the appLib package discovery profile will be removed as a background task.\nThe task will have JobType RemoveAppLibPackageDiscoveryProfile.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Get details of an AppLib Package Discovery profile.", "operationId": "AppLibPackageDiscovery_GetAppLibPackageDiscoveryProfile", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "description": "Uid of the appLib package discovery profile that need to be fetched.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the appLib package discovery profile will be fetched as a background task.\nThe task will have JobType GetAppLibPackageDiscoveryProfile.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "One appLib package discovery profile details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppLibPackageDiscoveryProfileResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Update the specified AppLib Package Discovery profile.", "operationId": "AppLibPackageDiscovery_UpdateAppLibPackageDiscoveryProfile", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "description": "Uid of the appLib package discovery profile that need to be fetched.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the appLib package discovery profile will be fetched as a background task.\nThe task will have JobType UpdateAppLibPackageDiscoveryProfile.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Request model to update a new AppLib package discovery profile.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditAppLibPackageDiscoveryProfileRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppLibPackageDiscovery/Profiles/{uid}/LatestSession": { "get": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Get the latest AppLib Package Discovery session for the specified profile id.", "operationId": "AppLibPackageDiscovery_GetAppLibPackageDiscoveryLatestSessionByProfileId", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "description": "The profile id.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "The latest session for the specified profile", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppLibPackageDiscoveryResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppLibPackageDiscovery/Sessions": { "get": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Get a list of AppLib Package Discovery sessions.", "operationId": "AppLibPackageDiscovery_GetAppLibPackageDiscoverySessions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the appLib package discovery sessions will be fetched as a background task.\nThe task will have JobType GetAppLibPackageDiscoveries.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "A list of AppLib package discovery sessions.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppLibPackageDiscoveryResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Create AppLib Package Discovery session", "operationId": "AppLibPackageDiscovery_CreateAppLibPackageDiscovery", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the appLib package discovery session will be created as a background task.\nThe task will have jobType CreateAppLibPackageDiscovery>", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Request model to create a new AppLib package discovery session.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppLibPackageDiscoveryRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppLibPackageDiscoveryResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppLibPackageDiscovery/Sessions/{id}": { "get": { "tags": [ "AppLibPackageDiscovery APIs" ], "summary": "Get details of an AppLib Package Discovery session.", "operationId": "AppLibPackageDiscovery_GetAppLibPackageDiscovery", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "Guid of the appLib package discovery session that need to be fetched.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the appLib package discovery session will be created as a background task.\nThe task will have jobType GetAppLibPackageDiscovery>", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppLibPackageDiscoveryResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationFolders": { "get": { "tags": [ "ApplicationFolders APIs" ], "summary": "Get application folders.", "description": "Gets all application folders within the site.", "operationId": "ApplicationFolders_GetApplicationFolders", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the application folders will be fetched as a background task.\nThe task will have JobType GetApplicationFolders.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 } ], "responses": { "200": { "description": "List of application folders.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationFolderResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "ApplicationFolders APIs" ], "summary": "Create an application folder", "description": "Create an application folder.", "operationId": "ApplicationFolders_CreateApplicationFolder", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the application folder will be created as a background task.\nThe task will have JobType \"JobType.CreateApplicationFolder\".\nWhen the task is complete it will redirect to\n\"GetApplicationFolder(string)\"\nThe job Parameters will contain properties:\n\n* _Name_ - Name of the folder being created.\n* _Path_ - Path to the folder being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the application folder to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateApplicationFolderRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Application folder details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationFolderResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationFolders/{path}": { "head": { "tags": [ "ApplicationFolders APIs" ], "summary": "Check for the existence of an application folder by path.", "description": "Check for the existence of an application folder by path.", "operationId": "ApplicationFolders_CheckApplicationFolderPathExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "path", "in": "path", "required": true, "description": "Path of the application folder.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationFolders/{pathOrId}": { "delete": { "tags": [ "ApplicationFolders APIs" ], "summary": "Delete an application folder.", "description": "Delete an application folder. Any applications within the application folder\nwill also be deleted.", "operationId": "ApplicationFolders_DeleteApplicationFolder", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Name or ID of the application folder to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the application folder (and associated objects) will be\ndeleted as a background task.\nThe task will have JobType DeleteApplicationFolder.\nWhen the task is complete it will redirect to\nGetApplicationFolders.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the application folder being deleted,\n* _Path_ - Path of the application folder being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "ApplicationFolders APIs" ], "summary": "Get details about a single application folder.", "description": "Gets the details of a single application folder.", "operationId": "ApplicationFolders_GetApplicationFolder", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Path (URL-encoded) or ID of the application folder.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Application folder details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationFolderResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "ApplicationFolders APIs" ], "summary": "Update an application folder.", "description": "Update an application folder's properties.", "operationId": "ApplicationFolders_UpdateApplicationFolder", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Path or ID of the application path to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the application folder will be updated as a background task.\nThe task will have JobType UpdateApplicationFolder.\nWhen the task is complete it will redirect to\nGetApplicationFolder.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the application folder being updated.\n* _Path_ - Path of the application folder being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "folder", "description": "Details of the application folder to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditApplicationFolderRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The async job or the applications folder.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationFolderResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationFolders/{pathOrId}/Applications": { "get": { "tags": [ "ApplicationFolders APIs" ], "summary": "Get the applications in an application folder.", "description": "Get a list of all applications in an application folder.", "operationId": "ApplicationFolders_GetApplicationFolderApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "pathOrId", "in": "path", "required": true, "description": "Path (URL-encoded) or ID of the application folder.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ApplicationFolder" }, { "name": "async", "in": "query", "description": "If `true`, Fetch applications under application folder will be a background task.\nThe task will have JobType GetApplicationFolderApplications", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of applications in the folder.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups": { "get": { "tags": [ "ApplicationGroups APIs" ], "summary": "Get application groups.", "description": "Get all application groups in the site.", "operationId": "ApplicationGroups_GetApplicationGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "adminFolder", "in": "query", "description": "Optional folder path (URL-encoded) or ID. If not specified, all applications will\nbe returned from all folders.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of application groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ContainerScopes" }, { "name": "async", "in": "query", "description": "If `true`, the application groups will be fetched as a background task.\nThe task will have JobType GetApplicationGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "List of application groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "ApplicationGroups APIs" ], "summary": "Create an application group.", "operationId": "ApplicationGroups_CreateApplicationGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the application group (and associated objects) will be created as a\nbackground task.\nThe task will have JobType CreateApplicationGroup.\nWhen the task is complete it will redirect to\nGetApplicationGroupAsync.\nThe job's Parameters will contain properties:\n* _Name_ - Name of the application group being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "appGroup", "description": "Details of the application group to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateApplicationGroupRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationGroupDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/$checkNameExists": { "post": { "tags": [ "ApplicationGroups APIs" ], "summary": "Test the existence of an application group by name.", "description": "If the name is found to be available, this returns 404 Not Found. If the name\nis not available (i.e. an application group with the name was found), this\nreturns 204 No Content.", "operationId": "ApplicationGroups_TestApplicationGroupExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "Request model of application group name.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationGroupNameCheckRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/$search": { "post": { "tags": [ "ApplicationGroups APIs" ], "summary": "Perform an advanced search for application groups.", "description": "Perform an advanced search for application groups. Note that some combinations\nof search parameters may result in slow performance.", "operationId": "ApplicationGroups_DoApplicationGroupSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of application groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the application groups (and associated objects) will be added as a\nbackground task.\nThe task will have JobType SearchApplicationGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationGroupSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of application groups that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/{name}": { "head": { "tags": [ "ApplicationGroups APIs" ], "summary": "Check for the existence of an application group by name.", "description": "If the name is found to be available, this returns 404 Not Found. If the name\nis not available (i.e. an application group with the name was found), this\nreturns 204 No Content.", "operationId": "ApplicationGroups_CheckApplicationGroupExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the application group.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/{nameOrId}": { "delete": { "tags": [ "ApplicationGroups APIs" ], "summary": "Delete an application group.", "description": "Delete an application group. Any applications that exist only within the\napplication group will also be deleted. The impact can be determined\nbeforehand by use of the `exclusive` option with\nGetApplicationGroupApplicationsAsync.", "operationId": "ApplicationGroups_DeleteApplicationGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group to delete. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the application group (and associated objects) will be deleted as a\nbackground task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "ApplicationGroups APIs" ], "summary": "Get details of a single application group.", "operationId": "ApplicationGroups_GetApplicationGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Id,Uid,ContainerScopes" }, { "name": "async", "in": "query", "description": "If `true`, the application group details will be fetched as a background task.\nThe task will have JobType GetApplicationGroup.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "Details of the application group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationGroupDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "ApplicationGroups APIs" ], "summary": "Update an application group.", "description": "Update an application group's properties.", "operationId": "ApplicationGroups_UpdateApplicationGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group to update. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the application group (and associated objects) will be updated as a\nbackground task.\nThe task will have JobType UpdateApplicationGroup.\nWhen the task is complete it will redirect to\nGetApplicationGroupAsync.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application group being updated.\n* _Name_ - Name of the application group being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "appGroup", "description": "Details of the application group to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditApplicationGroupRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/{nameOrId}/Applications": { "get": { "tags": [ "ApplicationGroups APIs" ], "summary": "Get applications in an application group.", "description": "Get all applications in an application group.", "operationId": "ApplicationGroups_GetApplicationGroupApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ApplicationFolder" }, { "name": "async", "in": "query", "description": "If \"true\", the applications under the application group will be fetched as a background task.\nThe task will have JobType GetApplicationGroupApplications", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "List of applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "ApplicationGroups APIs" ], "summary": "Add applications to the application group.", "operationId": "ApplicationGroups_AddApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the applications (and associated objects) will be\nadded as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "apps", "description": "Details of the applications to add.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationGroupAddApplicationsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/{nameOrId}/Applications/{appNameOrId}": { "delete": { "tags": [ "ApplicationGroups APIs" ], "summary": "Remove an application from the application group.", "description": "Remove an application from the application group. If the application is not\nassociated with any other application group or delivery group, the application\nwill be deleted; otherwise, the application itself will remain in the site.", "operationId": "ApplicationGroups_RemoveApplication", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "appNameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the application will be removed from the application group as a\nbackground task.\nThe task will have JobType RemoveApplicationGroupApplications.\nWhen the task is complete it will redirect to\nGetApplicationGroupApplicationsAsync.\nThe job's Parameters will contain properties:\n* _ApplicationGroupId_ - ID of the application group.\n* _ApplicationGroupName_ - Name of the application group.\n* _ApplicationId_ - ID of the application.\n* _ApplicationName_ - Name of the application.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/{nameOrId}/DeliveryGroups": { "get": { "tags": [ "ApplicationGroups APIs" ], "summary": "Get delivery groups for an application group.", "description": "Get all delivery groups which an application group is associated with.\n\nThe of each\nassociation specifies the priority of the mapping between the application\ngroup and delivery group. Lower numbers imply higher priority with zero being\nhighest.\n\n\nIf one association has a higher priority than the other, machines from that\ngroup will be selected for launching sessions until all machines are at\nmaximum load, in maintenance mode, unregistered, or unavailable for any other\nreason. Only when all machines from the higher-priority delivery group are\nunavailable will new connections be routed to the next lowest priority\ndelivery group.\n\nIf multiple associations with equal priorities are encountered, session\nlaunches will be load balanced across all machines in both delivery groups.\nThe least-loaded machine across the delivery groups will be chosen.", "operationId": "ApplicationGroups_GetApplicationGroupDeliveryGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of delivery groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the delivery groups fetch will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 4 } ], "responses": { "200": { "description": "List of delivery groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationGroupDeliveryGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/{nameOrId}/Tags": { "get": { "tags": [ "ApplicationGroups APIs" ], "summary": "Get the tags for an application group.", "description": "Get the tags associated with an application group. This includes tags which\nare directly associated with the application group, as well as tags associated\nwith delivery groups, machines, or applications that are associated with the\napplication group. To find tags that are directly associated with the application\ngroup only, filter the results to those with\nNumApplicationGroups equal to `1`.", "operationId": "ApplicationGroups_GetApplicationGroupTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "field to filter response model.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Name,Id,Description" } ], "responses": { "200": { "description": "List of tags.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "ApplicationGroups APIs" ], "summary": "Set the tags for an application group.", "description": "Set the tags associated with an application group.\nAny tag that is not specified will be removed from the application group if it\nwas previously associated.", "operationId": "ApplicationGroups_SetApplicationGroupTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType SetTagApplicationGroups.\nWhen the task is complete it will redirect to\nGetApplicationGroupTags.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application group being tagged,\n* _Name_ - Name of the application group being tagged.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Tags to set.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroups/{nameOrId}/Tags/{tagNameOrId}": { "delete": { "tags": [ "ApplicationGroups APIs" ], "summary": "Remove a tag from an application group.", "description": "Remove a tag from an application group. Does not delete the tag, only its\nassociation to the application group.", "operationId": "ApplicationGroups_RemoveApplicationGroupTag", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag to remove.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType SetTagApplicationGroups.\nWhen the task is complete it will redirect to\nGetApplicationGroupTags.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application group being tagged,\n* _Name_ - Name of the application group being tagged.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "ApplicationGroups APIs" ], "summary": "Add a tag to an application group.", "operationId": "ApplicationGroups_AddApplicationGroupTag", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag to add.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType SetTagApplicationGroups.\nWhen the task is complete it will redirect to\nGetApplicationGroupTags.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application group being tagged,\n* _Name_ - Name of the application group being tagged.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "List of tags associated with the application group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationGroupsV2": { "get": { "tags": [ "ApplicationGroups APIs" ], "summary": "The V2 version of get application groups.", "description": "Get all application groups in the site with default response fields if no fields parameters specified.", "operationId": "ApplicationGroups_GetApplicationGroupsV2", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "adminFolder", "in": "query", "description": "Optional folder path (URL-encoded) or ID. If not specified, all applications will\nbe returned from all folders.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of application groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ContainerScopes" }, { "name": "async", "in": "query", "description": "If `true`, the application groups will be fetched as a background task.\nThe task will have JobType GetApplicationGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "List of application groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications": { "get": { "tags": [ "Applications APIs" ], "summary": "Get all applications.", "description": "Get all applications in the site.", "operationId": "Applications_GetApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "applicationFolder", "in": "query", "description": "Optional folder path (URL-encoded) or ID. If not specified, all applications will\nbe returned from all folders.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma ','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ApplicationFolder" }, { "name": "async", "in": "query", "description": "If `true`, the applications will be fetched as a background task.\nThe task will have JobType GetApplications.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Applications APIs" ], "summary": "Add applications to the site.", "description": "Add request applications to the site.", "operationId": "Applications_AddApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the applications (and associated objects) will be added as a\nbackground task.\nThe task will have JobType AddApplications.\nWhen the task is complete it will redirect to\nGetApplicationsV2Async.\nThe job's Parameters will contain properties:\n* _NumApplications_ - Number of applications being added.\n* _Name0_ - Name of the first application being added.\n* _Name1_ - Name of the second application being added.\n* _Name{n}_ - ...And so on.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "apps", "description": "Details of the applications to add.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AddApplicationsRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/$search": { "post": { "tags": [ "Applications APIs" ], "summary": "Perform an advanced search for applications.", "description": "Perform an advanced search for applications. Note that some combinations\nof search parameters may result in slow performance.", "operationId": "Applications_DoApplicationSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the applications (and associated objects) will be added as a\nbackground task.\nThe task will have JobType SearchApplications.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of applications that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{name}": { "head": { "tags": [ "Applications APIs" ], "summary": "Check for the existence of an application by name", "description": "Check for the existence of an application by name.", "operationId": "Applications_CheckApplicationExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name or ID of the application to check for. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}": { "delete": { "tags": [ "Applications APIs" ], "summary": "Delete an application!", "description": "Delete an application.", "operationId": "Applications_DeleteApplication", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application to delete. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the application (and associated objects) will be\ndeleted as a background task.\nThe task will have JobType DeleteApplication.\nWhen the task is complete it will redirect to\nGetApplicationsV2Async.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the application being deleted,\n* _Name_ - Name of the application being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Applications APIs" ], "summary": "Get details of a single application.", "description": "Get the details of a single application.", "operationId": "Applications_GetApplication", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma ','.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Id,Uid,ApplicationFolder" }, { "name": "async", "in": "query", "description": "If `true`, the applications will be fetched as a background task.\nThe task will have JobType GetApplications.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Application details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Applications APIs" ], "summary": "Modify an application.", "description": "Patch an application.", "operationId": "Applications_PatchApplication", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the application will be updated as a background task.\nThe task will have JobType UpdateApplication.\nWhen the task is complete it will redirect to\nGetApplication.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application being updated,\n* _Name_ - Name of the application being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "app", "description": "Properties of the application to modify.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditApplicationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/$duplicate": { "post": { "tags": [ "Applications APIs" ], "summary": "Duplicate an application.", "description": "Duplicate an application. This is equivalent to creating\na new application with all properties the same as the original,\nbut with a new name.\n------\nThis API is preferable to using client-side logic to duplicate the\napplication, since it allows forward-compatibility. As new properties\nand behaviors of applications are added in the future, this API will\nduplicate those properly without needing to update clients.", "operationId": "Applications_DuplicateApplication", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application to duplicate. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the application (and associated objects) will be\nduplicated as a background task.\nThe task will have JobType AddApplications.\nWhen the task is complete it will redirect to\nGetApplicationsV2Async.\nThe job's Parameters will contain properties:\n* _NumApplications_ - Number of applications being added. For a duplicate operation, this will always be 1.\n* _Name0_ - Name of the first application being added. For a duplicate operation, this will be the name of the new duplicate of the original application.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "options", "description": "Optional properties controlling how the new application is created.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DuplicateApplicationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Details of the newly created application duplicate.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/Administrators": { "get": { "tags": [ "Applications APIs" ], "summary": "Get administrators authorized to administer an application.", "description": "Get the administrators authorized to administer an application.", "operationId": "Applications_GetApplicationAdministrators", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of administrators returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of administrators.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/ApplicationGroups": { "get": { "tags": [ "Applications APIs" ], "summary": "Get application groups associated with an application.", "description": "Get the application groups associated with an application.", "operationId": "Applications_GetApplicationApplicationGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of application groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the application groups associated with the application will be fetched as a background task.\nThe task will have JobType GetApplicationApplicationGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 4 } ], "responses": { "200": { "description": "List of application groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/DeliveryGroups": { "get": { "tags": [ "Applications APIs" ], "summary": "Get delivery groups associated with an application.", "description": "Get the delivery groups associated with an application.", "operationId": "Applications_GetApplicationDeliveryGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of delivery groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Priority" }, { "name": "async", "in": "query", "description": "If `true`, the delivery groups associated with the application will be fetched as a background task.\nThe task will have JobType GetApplicationDeliveryGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "List of delivery groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationDeliveryGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/FileTypes": { "get": { "tags": [ "Applications APIs" ], "summary": "Get all file-types for an application.", "description": "Get the file-type associations for an application. This is a list of all file\ntypes which are currently associated with the application, plus all imported\nfile types that are related to the application's command line executable.\n-------\nThis API is only valid for applications where\nApplicationType is\nHostedOnDesktop,\nAppV, or\nAppLibraryAppV, or\nMsix, or\nAppAttach, or\nFlexApp, or\nElasticAppLayer", "operationId": "Applications_GetApplicationFtas", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "skipVdaChecking", "in": "query", "description": "If true, don't check the status of VDAs before\n getting the file-type association for the application.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If 'true', the file types will be gotten as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of file-type associations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/FtaResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Applications APIs" ], "summary": "Enable a file-type association for an application.", "description": "Enable a file-type association for an application. Note that if the file-type\nassociation was not imported, this will cause it to be created.\nTo enable multiple file-type associations at once, use\n\n BatchControllerTP.DoBatchRequest(BatchRequestModel, bool?)\n\n.", "operationId": "Applications_EnableApplicationFta", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "skipVdaChecking", "in": "query", "description": "If true, don't check the status of VDAs before\n enabling the file-type association for the application.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the file type will be enabled as a background task.\nThe task will have JobType ModifyFTA.\nWhen the task is complete it will redirect to\nGetApplicationFta.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application whose FTA is being modified,\n* _Name_ - Name of the application whose FTA is being modified.\n* _ExtensionName_ - File type extension name being modified.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "fta", "description": "Details of the file-type association to enable.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/FtaRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/FileTypes/$import": { "post": { "tags": [ "Applications APIs" ], "summary": "Import file types for the application.", "description": "Import file types. The specified application guides the system to import the\nfile types from a machine within one of the delivery groups to which the\napplication is associated. Note that all file types present on the chosen\nmachine are imported. For this reason, importing file types for one\napplication may alter the imported file types for other applications.\nThis API is only valid for applications where\nApplicationType is\nHostedOnDesktop. App-V applications do not\nrequire their file types to be imported.", "operationId": "Applications_ImportFileTypes", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the file types will be imported as a background task. This is\nrecommended as this operation may cause a power action, turning on a machine\nin order to gather the data. This may take some time to run, and if it exceeds\n90 seconds the request may time out.\nThe task will have JobType ImportFTA.\nWhen the task is complete it will redirect to\nGetApplicationFtas.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application whose FTA is being imported,\n* _Name_ - Name of the application whose FTA is being imported.\n* _MachineId_ - ID of the machine selected, from which the file types are being imported; will be present in Parameters only after a machine is selected.\n* _MachineName_ - Name of the machine selected, from which the file types are being imported; will be present in Parameters only after a machine is selected.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/FileTypes/{extensionName}": { "delete": { "tags": [ "Applications APIs" ], "summary": "Disable a file-type association for an application.", "description": "Disable a file-type association for an application. Note that if the\nfile-type association was not imported, this will cause it to be deleted.\nTo disable multiple file-type associations at once, use\n\n BatchControllerTP.DoBatchRequest(BatchRequestModel, bool?)\n\n.", "operationId": "Applications_DisableApplicationFta", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "extensionName", "in": "path", "required": true, "description": "File-type extension name to disable.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the file type will be disabled as a background task.\nThe task will have JobType ModifyFTA.\nWhen the task is complete it will redirect to\nGetApplicationFta.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application whose FTA is being modified,\n* _Name_ - Name of the application whose FTA is being modified.\n* _ExtensionName_ - File type extension name being modified.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Applications APIs" ], "summary": "Get a single file-type for an application.", "description": "Get the details for a file-type association for an application.\n----\nThis API is only valid for applications where\nApplicationType is\nHostedOnDesktop,\nAppV, or\nAppLibraryAppV, or\nMsix, or\nAppAttach, or\nFlexApp, or\nElasticAppLayer", "operationId": "Applications_GetApplicationFta", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "extensionName", "in": "path", "required": true, "description": "Extension name of the file-type.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "A single file-type association.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/FtaResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/RecommendName": { "get": { "tags": [ "Applications APIs" ], "summary": "Get an application's recommend name.", "description": "Get an application's recommend name.\nThis API will check the application name is already in use or not.\nif application Folder is specified, This API will check the application name in the application folder.\nIf it's in use, a new name will be suggested.", "operationId": "Applications_GetApplicationRecommendName", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "applicationFolder", "in": "query", "description": "Name or ID of the application Folder", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "The recommend name of the application", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "String", "type": "string" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/Sessions": { "get": { "tags": [ "Applications APIs" ], "summary": "Get sessions in which the application is currently running.", "description": "Get the sessions in which the application is currently running.", "operationId": "Applications_GetApplicationSessions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of sessions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the application sessions will be fetched as a background task.\nThe task will have JobType GetApplicationSessions.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "List of sessions.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/Tags": { "get": { "tags": [ "Applications APIs" ], "summary": "Get tags associated with an application.", "description": "Get tags associated with an application. This includes tags which are\ndirectly associated with the application, as well as tags associated with\ndelivery groups, machines, or application groups that are associated with the\napplication. To find only tags directly associated with the application,\nfilter the results to those with\nNumApplications equal to `1`.", "operationId": "Applications_GetApplicationTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "field to filter response model.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Name,Id,Description" } ], "responses": { "200": { "description": "List of tags.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "Applications APIs" ], "summary": "Set tags associated with an application.", "description": "Set tags associated with an application.", "operationId": "Applications_SetApplicationTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType SetTagApplications.\nWhen the task is complete it will redirect to\nGetApplicationTags.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application being tagged,\n* _Name_ - Name of the application being tagged.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of which tags to set.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/{nameOrId}/Tags/{tagNameOrId}": { "delete": { "tags": [ "Applications APIs" ], "summary": "Remove a tag from an application.", "description": "Remove a tag from an application. Does not delete the tag, only its\nassociation to the application.", "operationId": "Applications_RemoveApplicationTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag to remove.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType SetTagApplications.\nWhen the task is complete it will redirect to\nGetApplicationTags.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application being tagged,\n* _Name_ - Name of the application being tagged.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Applications APIs" ], "summary": "Add a tag to an application.", "description": "Add a tag to an application.", "operationId": "Applications_AddApplicationTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the application. If the application is present in an application folder,\n specify the name in this format: {application folder path plus application name}.\n For example, FolderName1|FolderName2|ApplicationName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag to add.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType SetTagApplications.\nWhen the task is complete it will redirect to\nGetApplicationTags.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the application being tagged,\n* _Name_ - Name of the application being tagged.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "List of tags associated with the application.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/RefreshAppVApplications": { "get": { "tags": [ "Applications APIs" ], "summary": "Refresh the AppV Applications.", "operationId": "Applications_RefreshAppVApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the refresh operation will run as a background task.\nThe task will have JobType RefreshAppVApplications.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The applications that need to be deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Applications/StartMenuApplications": { "post": { "tags": [ "Applications APIs" ], "summary": "Search Start Menu Applications.", "operationId": "Applications_SearchStartMenuApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the search operation will run as a background task.\nThe task will have JobType SearchStartMenuApplications", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Search request for querying start menu applications. SearchStartMenuApplicationsRequestModel", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SearchStartMenuApplicationsRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "The collection of start menu applications", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StartMenuApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ApplicationsV2": { "get": { "tags": [ "Applications APIs" ], "summary": "The V2 of get all applications.", "description": "Get all applications in the site with default response fields if no fields parameters specified.", "operationId": "Applications_GetApplicationsV2", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "applicationFolder", "in": "query", "description": "Optional folder path (URL-encoded) or ID. If not specified, all applications will\nbe returned from all folders.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma ','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ApplicationFolder" }, { "name": "async", "in": "query", "description": "If `true`, the applications will be fetched as a background task.\nThe task will have JobType GetApplications.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVIsolationGroups": { "get": { "tags": [ "AppVIsolationGroups APIs" ], "summary": "Get the App-V IsolationGroups configured in the site", "description": "Get all App-V IsolationGroups configured in the site.", "operationId": "AppVIsolationGroups_GetAppVIsolationGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 } ], "responses": { "200": { "description": "List of App-V IsolationGroups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVIsolationGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "AppVIsolationGroups APIs" ], "summary": "Create an App-V IsolationGroup in the site", "description": "Create requested App-V IsolationGroup in the site.", "operationId": "AppVIsolationGroups_CreateAppVIsolationGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType CreateAppVIsolationGroup.\nWhen the task is complete it will redirect to\nGetAppVIsolationGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Request model of the new IsolationGroup.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateAppVIsolationGroupRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVIsolationGroups/{nameOrId}": { "delete": { "tags": [ "AppVIsolationGroups APIs" ], "summary": "Delete an App-V IsolationGroup configured in the site.", "description": "Delete the specified App-V IsolationGroup .", "operationId": "AppVIsolationGroups_DeleteAppVIsolationGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or UID of an isolationGroup.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType CreateAppVIsolationGroup.\nWhen the task is complete it will redirect to\nGetAppVIsolationGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "AppVIsolationGroups APIs" ], "summary": "Get the specified App-V IsolationGroups configured in the site", "description": "Get the specified App-V IsolationGroups configured in the site.", "operationId": "AppVIsolationGroups_GetAppVIsolationGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or UID of an isolationGroup.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType GetAppVIsolationGroup.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "200": { "description": "List of App-V IsolationGroups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVIsolationGroupResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "AppVIsolationGroups APIs" ], "summary": "Update the App-V IsolationGroup configured in the site.", "description": "Update the requested App-V IsolationGroup in the site.", "operationId": "AppVIsolationGroups_UpdateAppVIsolationGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or UID of an isolationGroup.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType UpdateAppVIsolationGroup.\nWhen the task is complete it will redirect to\nGetAppVIsolationGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "request model to update isolationGroup.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateAppVIsolationGroupRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages": { "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get the App-V packages configured in the site", "description": "Get all App-V packages configured in the site.", "operationId": "AppVPackages_GetAppVPackages", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the packages will be fetched as a background task.\nThe task will have JobType GetAppVPackages.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "AppVApplications,Description,Exists" } ], "responses": { "200": { "description": "List of App-V packages.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVPackageResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "AppVPackages APIs" ], "summary": "Import App-V packages to the site", "description": "Import App-V packages to the site.", "operationId": "AppVPackages_ImportAppVPackages", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the packages will be imported as a background task.\nThe task will have JobType ImportAppVPackages.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Request model that includes packages path.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVPackageRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages/{id}": { "delete": { "tags": [ "AppVPackages APIs" ], "summary": "Remove a single App-V package within the site", "description": "Remove a single App-V package within the site.", "operationId": "AppVPackages_RemoveAppVPackage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionId", "in": "query", "description": "Package version guid.\n If not specified, the first package with the id will be removed.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType UpdateAppVIsolationGroup.\nWhen the task is complete it will redirect to\nGetAppVPackages.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get the details for a single App-V package within the site", "description": "Get the details for a single App-V package within the site.", "operationId": "AppVPackages_GetAppVPackage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "libraryUid", "in": "query", "description": "ID of the library where the package is present.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "versionId", "in": "query", "description": "Package version guid. If not specified, return the first\n package with id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "AppVApplications,Description,Exists" } ], "responses": { "200": { "description": "App-V package details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVPackageResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages/{id}/Applications": { "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get App-V applications within an App-V package", "description": "Get App-V applications within an App-V package.", "operationId": "AppVPackages_GetAppVPackageApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "App-V applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVApplicationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages/{id}/Applications/{appId}": { "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get details for a single App-V application within an App-V package", "description": "Get details for a single App-V application within an App-V package.", "operationId": "AppVPackages_GetAppVPackageApplication", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "appId", "in": "path", "required": true, "description": "ID of the App-V application within the package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details of the App-V application.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVApplicationDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages/{id}/Applications/{appId}/FileTypes": { "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get the fileTypes for an application within a package within the site.", "description": "Get the file types for an application within a package.", "operationId": "AppVPackages_GetPackageApplicationFileTypes", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "appId", "in": "path", "required": true, "description": "Identifier of the application within the package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "libraryUid", "in": "query", "required": true, "description": "ID of the library where the package is present.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "File types details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FtaResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages/{id}/Applications/{appId}/Icon": { "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get the icon for a single App-V application within an App-V package\nwithin the site.", "description": "Get the icon for a single App-V application within an App-V package.", "operationId": "AppVPackages_GetAppVPackageApplicationIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "appId", "in": "path", "required": true, "description": "ID of the App-V application within the package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "iconFormat", "in": "query", "description": "Icon format. Must be:\n`{mime-type};{width}x{height}x{colordepth}`\n\nwhere:\n\n\n* _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n* _width_ and _height_ are specified in pixels.\n* _colordepth_ (optional) is either `8` or `24`.\n\n\nOptional. If not specified, only the raw icon data will be returned.\nNote that this is typically in ICO format, which some clients cannot\ndisplay properly.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Icon details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconDataResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages/{id}/BrokerApplications": { "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get Broker applications delivered from the App-V package", "description": "Get Broker applications delivered from the App-V package.", "operationId": "AppVPackages_GetAppVPackageBrokerApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "libraryUid", "in": "query", "description": "ID of the library where the package is present.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "versionId", "in": "query", "description": "Package version Id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 }, { "name": "fields", "in": "query", "description": "The required fields.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6, "example": "Id,Uid,ApplicationFolder" }, { "name": "async", "in": "query", "description": "If `true`, the applications will be fetched as a background task.\nThe task will have JobType GetAppVPackageBrokerApplications.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 7 } ], "responses": { "200": { "description": "Broker applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages/{id}/DeliveryGroups": { "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get delivery groups which contain applications in the App-V package", "description": "Get delivery groups which contain applications in the App-V package.", "operationId": "AppVPackages_GetAppVPackageDeliveryGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "libraryUid", "in": "query", "description": "ID of the library where the package is present.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "versionId", "in": "query", "description": "Package version Id. If not specified, all delivery groups\n that associated with id will be fetched.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "The max number of delivery groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 }, { "name": "fields", "in": "query", "description": "The required fields.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6, "example": "Id,Uid,UserManagement" }, { "name": "async", "in": "query", "description": "If `true`, the delivery groups will be fetched as a background task.\nThe task will have JobType GetAppVPackageDelveryGroups.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 7 } ], "responses": { "200": { "description": "The delivery groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DeliveryGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVPackages/{id}/Icon": { "get": { "tags": [ "AppVPackages APIs" ], "summary": "Get the icon for a single App-V package within the site", "description": "Get the icon for a single App-V package within the site.", "operationId": "AppVPackages_GetAppVPackageIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "iconFormat", "in": "query", "description": "Icon format. Must be:\n`{mime-type};{width}x{height}x{colordepth}`\n\nwhere:\n\n\n* _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n* _width_ and _height_ are specified in pixels.\n* _colordepth_ (optional) is either `8` or `24`.\n\n\nOptional. If not specified, only the raw icon data will be returned.\nNote that this is typically in ICO format, which some clients cannot\ndisplay properly.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Icon details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconDataResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVServers": { "get": { "tags": [ "AppVServers APIs" ], "summary": "Get all App-V servers configured in the site", "description": "Get all App-V servers configured in the site.", "operationId": "AppVServers_GetAppVServers", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of App-V servers.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVServerResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVServers/{server}/Packages": { "get": { "tags": [ "AppVServers APIs" ], "summary": "Get the packages from a single App-V server", "description": "Get the packages from a single App-V server.", "operationId": "AppVServers_GetAppVServerPackages", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "server", "in": "path", "required": true, "description": "Management Server address of the App-V server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of App-V packages.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVPackageResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVServers/{server}/Packages/{id}": { "get": { "tags": [ "AppVServers APIs" ], "summary": "Get the details for a single App-V package on a server.", "description": "Get the details for a single App-V package on a server (as opposed\nto within the site).", "operationId": "AppVServers_GetAppVServerPackage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "server", "in": "path", "required": true, "description": "ManagementServer address of\nthe App-V server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "App-V package details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVPackageResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVServers/{server}/Packages/{id}/Applications": { "get": { "tags": [ "AppVServers APIs" ], "summary": "Get App-V applications within an App-V package on a server.", "description": "Get App-V applications within an App-V package on a server (as\nopposed to within the site).", "operationId": "AppVServers_GetAppVServerPackageApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "server", "in": "path", "required": true, "description": "Management Server address of the App-V server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "App-V applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVApplicationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVServers/{server}/Packages/{id}/Applications/{appId}": { "get": { "tags": [ "AppVServers APIs" ], "summary": "Get details for a single App-V application on a server.", "description": "Get details for a single App-V application on a server (as\nopposed to within the site).", "operationId": "AppVServers_GetAppVServerPackageApplication", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "server", "in": "path", "required": true, "description": "Management Server address of the App-V server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "appId", "in": "path", "required": true, "description": "ID of the App-V application within the package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Details of the App-V application.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppVApplicationDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVServers/{server}/Packages/{id}/Applications/{appId}/Icon": { "get": { "tags": [ "AppVServers APIs" ], "summary": "Get the icon for a App-V application", "description": "Get the icon for a single App-V package on a server (as\nopposed to within the site).", "operationId": "AppVServers_GetAppVServerPackageApplicationIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "server", "in": "path", "required": true, "description": "Management Server address of the App-V server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "appId", "in": "path", "required": true, "description": "ID of the App-V application within the package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "iconFormat", "in": "query", "description": "Icon format. Must be:\n`{mime-type};{width}x{height}x{colordepth}`\n\nwhere:\n\n\n* _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n* _width_ and _height_ are specified in pixels.\n* _colordepth_ (optional) is either `8` or `24`.\n\n\nOptional. If not specified, only the raw icon data will be returned.\nNote that this is typically in ICO format, which some clients cannot\ndisplay properly.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "Icon details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconDataResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/AppVServers/{server}/Packages/{id}/Icon": { "get": { "tags": [ "AppVServers APIs" ], "summary": "Get the icon for a single App-V package on a server.", "description": "Get the icon for a single App-V package on a server (as opposed to\nwithin the site).", "operationId": "AppVServers_GetAppVServerPackageIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "server", "in": "path", "required": true, "description": "Management Server address of the App-V server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "ID of the App-V package.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "iconFormat", "in": "query", "description": "Icon format. Must be:\n`{mime-type};{width}x{height}x{colordepth}`\n\nwhere:\n\n\n* _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n* _width_ and _height_ are specified in pixels.\n* _colordepth_ (optional) is either `8` or `24`.\n\n\nOptional. If not specified, only the raw icon data will be returned.\nNote that this is typically in ICO format, which some clients cannot\ndisplay properly.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Icon details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconDataResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get backups", "operationId": "BackupRestore_GetBackups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "allFiles", "in": "query", "description": "If `true`, include all backup files.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 }, { "name": "scheduleUid", "in": "query", "description": "Optional schedule UID filter. If specified, only returns backups created by that schedule.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of backups", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/{backupName}": { "delete": { "tags": [ "BackupRestore APIs" ], "summary": "Delete a backup", "description": "Deletes a backup; note that the backup cannot be pinned", "operationId": "BackupRestore_DeleteBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "backupName", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/{backupName}/Download": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Download single backup", "description": "Downloads a backup and any assicated failure zip files", "operationId": "BackupRestore_DownloadSingleBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "backupName", "in": "path", "required": true, "description": "Name of the backp to download", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreDownloadResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/{backupName}/History/All": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get all backup history for specific backup", "operationId": "BackupRestore_GetHistoryForSpecificBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "backupName", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "List of operational history", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreHistoryResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/{backupName}/Members": { "post": { "tags": [ "BackupRestore APIs" ], "summary": "Get backup Members", "description": "Gets a component's members in a saved backup", "operationId": "BackupRestore_GetComponentMembers", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "backupName", "in": "path", "required": true, "description": "Name of the backp to restore", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "requestBody": { "x-name": "getMembersRequest", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreGetComponentMemberRequestModel" } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupMembersResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/{backupName}/PinBackup": { "post": { "tags": [ "BackupRestore APIs" ], "summary": "Pin a backup", "description": "Pins a backup so it cannot be manually or automatically deleted", "operationId": "BackupRestore_PinSingleBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "backupName", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "Boolean", "type": "boolean" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/{backupName}/Restore": { "post": { "tags": [ "BackupRestore APIs" ], "summary": "Restore a backup", "description": "Restore a backup initiates the restore process; the actual process is asynchronous\nCall the get status Rest API to determine the progress of the restore request", "operationId": "BackupRestore_RestoreBackupToSite", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "backupName", "in": "path", "required": true, "description": "Name of the backp to restore", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "restoreRequest", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreRestoreBackupRequestModel" } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreRestoreBackupResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/{backupName}/ResultLog": { "post": { "tags": [ "BackupRestore APIs" ], "summary": "Get result log", "description": "Gets a the result log from a failed action", "operationId": "BackupRestore_GetResultLog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "backupName", "in": "path", "required": true, "description": "Name of the backp to restore", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreResultLogResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/{backupName}/UnpinBackup": { "post": { "tags": [ "BackupRestore APIs" ], "summary": "Unpin a backup", "description": "Unpins a backup so it can be manually or automatically deleted", "operationId": "BackupRestore_UnpinSingleBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "backupName", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "Boolean", "type": "boolean" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/DoBackup": { "post": { "tags": [ "BackupRestore APIs" ], "summary": "Do backup", "description": "Do backup initiates the backup process; the actual process is asynchronous\nCall the get status Rest API to determine the progress of the backup request", "operationId": "BackupRestore_DoBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "backupRequest", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreDoBackupRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "BackupDoBackupResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupDoBackupResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/History": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get all backup history", "operationId": "BackupRestore_GetAllBackupHistory", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of operational history", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreHistoryResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/History/{uid}": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get backup history for a single specific backup", "operationId": "BackupRestore_GetBackupHistoryForSpecificHistory", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "List of operational history", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreHistoryInformation" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "BackupRestore APIs" ], "summary": "Update notes in history entry", "operationId": "BackupRestore_UpdateBckRstrHistoryNotes", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "description": "History entry unique identifier", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 1 } ], "requestBody": { "x-name": "notes", "description": "new notes", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreUpdateNotesRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "Boolean", "type": "boolean" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Information": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get backup / restore information", "description": "Get backup / restore information", "operationId": "BackupRestore_GetInformation", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "BackupRestoreInformationRequestModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreInformationResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Options": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get backup / restore options", "description": "Get backup / restore options", "operationId": "BackupRestore_GetBackupRestoreOptions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "BackupRestoreStatusResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreOptionsResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "BackupRestore APIs" ], "summary": "Set backup / restore options", "description": "Set backup / restore options", "operationId": "BackupRestore_SetBackupRestoreOptions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "callersOptionsRequest", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreOptionsRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "BackupRestoreStatusResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreOptionsResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Schedule/{uid}": { "delete": { "tags": [ "BackupRestore APIs" ], "summary": "Delete backup schedule", "description": "Deletes a backup schedule", "operationId": "BackupRestore_DeleteBackupSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Schedules": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get backup schedules", "description": "Get backup schedules", "operationId": "BackupRestore_GetBackupSchedules", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "BackupRestoreStatusResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreScheduleModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "BackupRestore APIs" ], "summary": "Create backup schedule", "description": "Set / update existing backup schedule", "operationId": "BackupRestore_CreateBackupSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "schedule", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "BackupRestoreStatusResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreScheduleResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Schedules/{uid}": { "patch": { "tags": [ "BackupRestore APIs" ], "summary": "Modify backup schedules", "description": "Set / update existing backup schedule", "operationId": "BackupRestore_ModifyBackupSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 4 } ], "requestBody": { "x-name": "schedule", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "BackupRestoreStatusResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreScheduleResponseModel" } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Schedules/{Uid}": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get single backup schedule", "description": "Get backup schedules", "operationId": "BackupRestore_GetBackupSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "Uid", "in": "path", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 3 } ], "responses": { "200": { "description": "BackupRestoreScheduleModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreScheduleModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Schedules/{uid}/Disable": { "post": { "tags": [ "BackupRestore APIs" ], "summary": "Disable single backup schedule", "description": "Disables a single backup schedule", "operationId": "BackupRestore_DisableSingleBackupSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Schedules/{uid}/Enable": { "post": { "tags": [ "BackupRestore APIs" ], "summary": "Enable single backup schedule", "description": "Enables a single backup schedule", "operationId": "BackupRestore_EnableSingleBackupSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "uid", "in": "path", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Status": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get backup / restore status", "description": "Get backup / restore status", "operationId": "BackupRestore_GetCurrentActionStatus", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "BackupRestoreStatusResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreStatusResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "BackupRestore APIs" ], "summary": "Set backup / restore status", "description": "Get backup / restore status", "operationId": "BackupRestore_SetCurrentActionStatus", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "callersStatus", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreStatusRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreStatusResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Storage": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Get Blob Storage Information", "description": "On-Prem only", "operationId": "BackupRestore_GetBlobStorage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreStorageResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "BackupRestore APIs" ], "summary": "Set Blob Storage Information", "description": "On-Prem only", "operationId": "BackupRestore_SetBlobStorage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "callersStorageRequest", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreStorageRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreValidateStorageResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/BackupRestore/Storage/Validate": { "get": { "tags": [ "BackupRestore APIs" ], "summary": "Validate Storage", "description": "On-Prem only", "operationId": "BackupRestore_ValidateStorage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRestoreValidateStorageResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/ExportReport": { "post": { "tags": [ "ConfigLog APIs" ], "summary": "Export logging report data in the format of csv/html/both.", "operationId": "ConfigLog_ExportReportData", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If 'true', the exporting operation report will be executed as a background task.\nThe task wil have JobTypeExportOperationReport.\nWhen the task is complete it will redirect to GetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "customReportInfoRequestModel", "description": "CustomReportInfoRequest CustomReportInfoRequestModel", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CustomReportInfoRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Custom report string data CustomReportDataResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportDataResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/GetFirstLogDate": { "get": { "tags": [ "ConfigLog APIs" ], "summary": "Get first log date", "operationId": "ConfigLog_GetFirstLogDate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "LogSiteResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "String", "type": "string", "nullable": true } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/LoggingSite": { "get": { "tags": [ "ConfigLog APIs" ], "summary": "Get logging site details.", "operationId": "ConfigLog_GetLogSite", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "LogSiteResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogSiteResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "ConfigLog APIs" ], "summary": "Update logging site info.", "operationId": "ConfigLog_SetLogSite", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "requestModel", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/LogSiteRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "LogSiteResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogSiteResponseModel" } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/Logs": { "delete": { "tags": [ "ConfigLog APIs" ], "summary": "Delete logging event logs.", "operationId": "ConfigLog_DeleteLogs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If 'true', the deleting all operations will be executed as a background task.\nThe task wil have JobTypeDeleteAllOperations.\nWhen the task is complete it will redirect to GetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/Operations": { "get": { "tags": [ "ConfigLog APIs" ], "summary": "Get configuration log operations.", "description": "This requires the configuration logging database to be configured and enabled.\nResults are returned in the order of most-recent to least-recent.\nTo specify more complicated search criteria, use DoConfigLogSearchAsync.", "operationId": "ConfigLog_GetOperations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "text", "in": "query", "description": "Optional; Text pattern to match, which is case-insensitive and may include the wildcard \"*\".\nIf specified, only return records which Text matched pattern.\nOtherwise, all records will be returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "days", "in": "query", "description": "Optional; Number of days of history to retrieve.\nNote: This parameter is exclusive with parameter .\nIf neither is specified, all records will be returned.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "searchDateOption", "in": "query", "description": "Optional; Specific time filters for searching operations.\nNote: This parameter is exclusive with parameter days.\nIf neither is specified, all records will be returned.", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/SearchDateOption" } ] }, "x-position": 3 }, { "name": "timeDiff", "in": "query", "description": "[DEPRECATED]\nThis parameter is deprecated, please use \"X-TimeZone\" header instead.\nOptional; The time difference in seconds between client time and UTC time.\nNote: The value must be a valid UTC offset, e.g. UTC+8, timeDiff=28800; UTC-5, timeDiff=-18000.\nIf not specified, server local time will be referenced.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "limit", "in": "query", "description": "Optional; The max number of operations returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 5 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a ContinuationToken set.\nTo obtain more results from the query, pass the continuation token back into the query to get the next batch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6 }, { "name": "async", "in": "query", "description": "If 'true', the get operations will be executed as a background task.\nThe task wil have JobTypeGetOperations.\nWhen the task is complete it will redirect to GetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 7 } ], "responses": { "200": { "description": "List of configuration log operations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogOperationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/Operations/$fetchExistingLabels": { "post": { "tags": [ "ConfigLog APIs" ], "summary": "Fetch existing high level log operation labels.", "operationId": "ConfigLog_FetchExistingOperationLabels", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "refresh", "in": "query", "description": "If 'true', force fetching labels from all high level log operations and refresh the label cache,\nOtherwise, return labels directly from cache.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If 'true', the fetching existing operation labels will be executed as a background task.\nThe task wil have JobTypeFetchExistingOperationLabels.\nWhen the task is complete it will redirect to GetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of existing high level log operation labels.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/Operations/$search": { "post": { "tags": [ "ConfigLog APIs" ], "summary": "Perform an advanced search for configuration log entries.", "description": "Perform an advanced search for configuration log entries.", "operationId": "ConfigLog_DoConfigLogSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of configuration log entries returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set. To obtain more results\nfrom the query, pass the continuation token back into the query to get the\nnext batch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the search operations will be executed as a background task.\nThe task will have JobType DoOperationSearch.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/LogOperationSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of configuration log entries that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/LogOperationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/Operations/{id}": { "get": { "tags": [ "ConfigLog APIs" ], "summary": "Get a high level log operation.", "operationId": "ConfigLog_GetOperation", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The high level log operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogOperationResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "ConfigLog APIs" ], "summary": "Update a high level log operation.", "operationId": "ConfigLog_PatchOperation", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the operation will be updated as a background task.\nThe task will have JobType UpdateOperation.\nWhen the task is complete it will redirect to\nGetOperation.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the operation being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the operation to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditOperationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ConfigLog/Operations/{id}/LowLevelOperations": { "get": { "tags": [ "ConfigLog APIs" ], "summary": "Get the detailed low level operations of a high level operation.", "operationId": "ConfigLog_GetLowLevelOperations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "id of specified high level operation", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of low level operations returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "A list of low level operations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LowLevelOperationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get all delivery groups.", "description": "Get delivery groups in the site.", "operationId": "DeliveryGroups_GetDeliveryGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "adminFolder", "in": "query", "description": "Optional folder path (URL-encoded) or ID. If not specified, all delivery groups will\nbe returned from all folders.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of delivery groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5, "example": "Id,Uid,UserManagement" } ], "responses": { "200": { "description": "List of all delivery groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Create a delivery group.", "operationId": "DeliveryGroups_CreateDeliveryGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic delivery group info.", "schema": { "title": "Boolean", "type": "boolean", "default": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "Async request", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateDeliveryGroupRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Detail model of the created delivery group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/$checkName": { "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Test the existence of a delivery group by name.", "operationId": "DeliveryGroups_TestDeliveryGroupExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "Name of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DesktopGroupNameCheckRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/$GetFileTypes": { "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Returns the file type associations the system imports from worker machines in the specified delivery group.", "description": "Get the imported file-type for a delivery group. The imported file type associations are grouped according to the desktop group to which they belong,\nbecause the system expects all machines in the same desktop group to have the same file type associations.\nThat may not be true, however, across desktop groups.", "operationId": "DeliveryGroups_GetDeliveryGroupFtas", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "executableName", "in": "query", "description": "ExecutableName that used to filter imported file type associations. If specified, only\n the OpenExecutableName of imported file type associations that match will return.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If 'true', the file types will be gotten as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "deliveryGroupsFtaRequestModel", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DeliveryGroupsFtaRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of file-type associations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/FtaResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/$search": { "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Perform an advanced search for deliveryGroups.", "description": "Perform an advanced search for deliveryGroups. Note that some combinations\nof search parameters may result in slow performance.", "operationId": "DeliveryGroups_DoDeliveryGroupSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the delivery groups (and associated objects) will be added as a\nbackground task.\nThe task will have JobType DoDeliveryGroupSearch.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of delivery groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DeliveryGroupSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of delivery groups that matches the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{name}": { "head": { "tags": [ "DeliveryGroups APIs" ], "summary": "Check for the existence of a delivery group by name.", "operationId": "DeliveryGroups_CheckDeliveryGroupExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the delivery group.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Delete a delivery group.", "operationId": "DeliveryGroups_DeleteDeliveryGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Delivery group name or ID. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "Async or not", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "force", "in": "query", "description": "Bypass user assignment check", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get details of a single delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "Optional parameter, removing unspecified properties that otherwise would have been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Id,Uid,UserManagement" } ], "responses": { "200": { "description": "Detail model of the delivery group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DeliveryGroupDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "DeliveryGroups APIs" ], "summary": "Modify a delivery group.", "operationId": "DeliveryGroups_PatchDeliveryGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group to update. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the delivery group (and associated objects) will be updated as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the delivery group modifications requested.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditDeliveryGroupRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/$StartRebootCycle": { "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Start a reboot cycle for machines in a delivery group.", "operationId": "DeliveryGroups_StartDeliveryGroupRebootCycle", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, reboot cycle will be started as a background task.\nThe task will have JobType StartDeliveryGroupRebootCycle.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The request.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootCycleRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/$test": { "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Run tests on a delivery group and create a test report.", "operationId": "DeliveryGroups_TestDeliveryGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group to test. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tests will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "fields", "in": "query", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Delivery group test report.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupTestResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Administrators": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get administrators who can administer a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupsAdministrators", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of administrators returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of administrators.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/AdvancedAccessPolicies": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the advanced access policies associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupAdvancedAccessPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of advanced access policies returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of advanced access policies associated with the delivery group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedAccessPolicyResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Create an advanced access policy associated with a delivery group.", "operationId": "DeliveryGroups_CreateDeliveryGroupAdvancedAccessPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the advanced access policy will be created as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the advanced access policy to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdvancedAccessPolicyRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The created advanced access policy.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedAccessPolicyResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/AdvancedAccessPolicies/{policyId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Delete an advanced access policy associated with a delivery group.", "operationId": "DeliveryGroups_DeleteDeliveryGroupAdvancedAccessPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "policyId", "in": "path", "required": true, "description": "ID of the advanced access policy.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the advanced access policy will be deleted as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the details of a single advanced access policy associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupAdvancedAccessPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "policyId", "in": "path", "required": true, "description": "ID of the advanced access policy.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details of the access policy.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdvancedAccessPolicyResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "DeliveryGroups APIs" ], "summary": "Update an advanced access policy associated with a delivery group.", "operationId": "DeliveryGroups_PatchDeliveryGroupAdvancedAccessPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "policyId", "in": "path", "required": true, "description": "ID of the advanced access policy.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the advanced access policy will be updated as a background task. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Details of the advanced access policy to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdvancedAccessPolicyRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "The updated advanced access policy.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedAccessPolicyResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/ApplicationGroups": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the application groups associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupsApplicationGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of application groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of application groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationGroupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/ApplicationGroups/{appGroupNameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Remove an application group from a delivery group.", "operationId": "DeliveryGroups_DoRemoveApplicationGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "appGroupNameOrId", "in": "path", "required": true, "description": "Name or ID of the application group. If the application group is present in an application group folder,\n specify the name in this format: {application group folder path plus application group name}.\n For example, FolderName1|FolderName2|ApplicationGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the application groups will be removed to the delivery group\nas a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Applications": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the applications associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "List of applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Add applications and/or application groups to a delivery group.", "operationId": "DeliveryGroups_DoAddApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the applications will be added to the delivery group\nas a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the applications and application groups to add.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DeliveryGroupAddApplicationsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Applications/{appNameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Remove an application from a delivery group.", "operationId": "DeliveryGroups_DoRemoveApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "appNameOrId", "in": "path", "required": true, "description": "Name or ID of the application.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the applications will be removed to the delivery group\nas a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/AutoscaleGroupPlugins": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the autoscale group plugins for the specified delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupAutoscaleGroupPlugins", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in an admin folder,\n specify the name in this format: {admin folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "type", "in": "query", "description": "The type of the plugin.\n The supported types are: \"Holiday\", \"Intelligent\"\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If 'true', the autoscale group plugins will be gotten asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoscaleGroupPluginResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Create an autoscale group plugin for the speicified delivery group.", "operationId": "DeliveryGroups_CreateDeliveryGroupAutoscaleGroupPlugin", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in an admin folder,\n specify the name in this format: {admin folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If 'true', the template will be created asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "model", "description": "The autoscale group plugin create model", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateAutoscaleGroupPluginRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/AutoscaleGroupPlugins/{uid}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Delete the autoscale group plugin by uid.", "operationId": "DeliveryGroups_DeleteDeliveryGroupAutoscaleGroupPlugin", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in an admin folder,\n specify the name in this format: {admin folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "uid", "in": "path", "required": true, "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If 'true', the template will be deleted asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "DeliveryGroups APIs" ], "summary": "Update the autoscale group plugin by uid.", "operationId": "DeliveryGroups_UpdateDeliveryGroupAutoscaleGroupPlugin", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in an admin folder,\n specify the name in this format: {admin folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "uid", "in": "path", "required": true, "description": "The group plugin uid", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If 'true', the template will be updated asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "model", "description": "The autoscale group plugin update model", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateAutoscaleGroupPluginRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Desktops": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the published desktops associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupsDesktops", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of desktops returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "List of desktops.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DesktopResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/MachineCatalogs": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get machine catalogs associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupsMachineCatalogs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of machine catalogs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional parameters, removing unspecified properties that otherwise would have been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Name,FullName,Id" } ], "responses": { "200": { "description": "List of machine catalogs associated with a delivery group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCatalogResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Associate a machine catalog with a RemotePC delivery group.", "description": "Associate a machine catalog with a RemotePC delivery group. Only supported\nwhen both the delivery group and the machine catalog have\nIsRemotePC equal to `true`.\n\nFor non-RemotePC delivery groups, the relationship between machine catalog and\ndelivery group is implicit. A machine catalog is considered \"associated\" with\na delivery group if there is at least one machine from that catalog associated\nwith the delivery group. Adding a machine from a machine catalog to a delivery\ngroup will cause the machine catalog to be associated with the delivery group.", "operationId": "DeliveryGroups_AddDeliveryGroupMachineCatalog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the api need to return detail info in response model.\n Set to false will improve performance with return basic delivery group info.", "schema": { "title": "Boolean", "type": "boolean", "default": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the association will be updated as a background task.\nThe task will have JobType UpdateDeliveryGroup.\nWhen the task is complete it will redirect to\nGetDeliveryGroup.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the delivery group being updated.\n* _Name_ - Name of the delivery group being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "catalog", "description": "The machine catalog to associate.\n\nThe property must refer to a\nmachine catalog with \nequal to `true`. It may refer to the machine catalog by\n or by\n.\n\n\nThe machine catalog must be available to the same\n, or a superset of\n to whom the\ndelivery group is available.\n\nThe Priority property determines which\ndelivery group Remote PC automation will move a qualifying unconfigured\nmachine into when it registers. Priority also determines which delivery group\na machine will be published to when a user is assigned to the machine by\nRemote PC automation. Numerically lower values indicate a higher priority.\n\nIf a priority value is not supplied, then the delivery group association is\nautomatically assigned a lower priority than any existing associations.\n\nIf a priority value is specified that conflicts with an existing association's\npriority value, then the new association is inserted with that value and\nexisting associations are renumbered upwards to accommodate it.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PriorityRefRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Details of the delivery group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/MachineCatalogs/{catalogNameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Disassociate a machine catalog from a RemotePC delivery group.", "description": "Disassociate a machine catalog from a RemotePC delivery group. Only supported\nwhen IsRemotePC is equal to `true`.\n\nFor non-RemotePC delivery groups, the relationship between machine catalog and\ndelivery group is implicit. A machine catalog is considered \"associated\" with\na delivery group if there is at least one machine from that machine catalog\nassociated with the delivery group. Removing all machines within a machine\ncatalog from a delivery group will cause the machine catalog to be\ndisassociated from the delivery group.", "operationId": "DeliveryGroups_RemoveDeliveryGroupMachineCatalog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "catalogNameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to associate. If the ctalog is present in a catalog folder,\n specify the name in this format: {delivery group folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the api need to return detail info in response model.\n Set to false will improve performance with return basic delivery group info.", "schema": { "title": "Boolean", "type": "boolean", "default": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the association will be updated as a background task.\nThe task will have JobType UpdateDeliveryGroup.\nWhen the task is complete it will redirect to\nGetDeliveryGroup.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the delivery group being updated.\n* _Name_ - Name of the delivery group being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/MachineCatalogs/{id}": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the details of machine catalog associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupsMachineCatalogDetails", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {delivery group folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details of machine catalog.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCatalogDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Machines": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the machines associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of machines returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of machines.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Add machines to a delivery group.", "operationId": "DeliveryGroups_DoAddMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group to add machines to.\n If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic delivery group info.", "schema": { "title": "Boolean", "type": "boolean", "default": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the machines will be added to the delivery group", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Details of the machines to add.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DeliveryGroupAddMachinesRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Detail model of the delivery group after machines are added to.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Machines/{machineNameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Remove a machine from a delivery group.", "operationId": "DeliveryGroups_DoRemoveMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "machineNameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'.\n For instance, if a MachineName is \"DomainA\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the machines will be removed from the delivery group\nas a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/PowerTimeSchemes": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the power time schemes associated with a delivery group.", "description": "Get the power time schemes associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupPowerTimeSchemes", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of power time schemes returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of power time schemes.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PowerTimeSchemeResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Create a power time scheme for a delivery group.", "description": "Create a power time scheme for a delivery group.", "operationId": "DeliveryGroups_CreateDeliveryGroupPowerTimeScheme", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the power time scheme will be created as a background task.\nThe task will have JobType CreatePowerTimeScheme.\nWhen the task is complete it will redirect to\nGetDeliveryGroupPowerTimeScheme.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the delivery group for which a power time scheme is being created,\n* _Name_ - Name of the delivery group for which a power time scheme is being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the power time scheme to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PowerTimeSchemeRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Newly created power time scheme.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PowerTimeSchemeResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/PowerTimeSchemes/{schemeNameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Delete a power time scheme from a delivery group.", "description": "Delete a power time scheme from a delivery group.", "operationId": "DeliveryGroups_DeleteDeliveryGroupPowerTimeScheme", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group.If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "schemeNameOrId", "in": "path", "required": true, "description": "Name or ID of the power time scheme.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the power time scheme will be deleted as a background task.\nThe task will have JobType DeletePowerTimeScheme.\nWhen the task is complete it will redirect to\nGetDeliveryGroupPowerTimeSchemes.\nThe job's Parameters will contain properties:\n\n*_Id_ - ID of the delivery group for which a power time scheme is being deleted,\n*_Name_ - Name of the delivery group for which a power time scheme is being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the details about a single power time scheme associated with a delivery\ngroup.", "description": "Get the details about a single power time scheme associated with a delivery\ngroup.", "operationId": "DeliveryGroups_GetDeliveryGroupPowerTimeScheme", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "schemeNameOrId", "in": "path", "required": true, "description": "Name or ID of the power time scheme.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details about a power time scheme.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PowerTimeSchemeResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "DeliveryGroups APIs" ], "summary": "Update a power time scheme for a delivery group.", "description": "Update a power time scheme for a delivery group.", "operationId": "DeliveryGroups_PatchDeliveryGroupPowerTimeScheme", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "schemeNameOrId", "in": "path", "required": true, "description": "Name or ID of the power time scheme to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the power time scheme will be updated as a background task.\nThe task will have JobType UpdatePowerTimeScheme.\nWhen the task is complete it will redirect to\nGetDeliveryGroupPowerTimeScheme.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the delivery group for which a power time scheme is being updated,\n* _Name_ - Name of the delivery group for which a power time scheme is being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Details of the update request.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PowerTimeSchemeRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Updated power time scheme.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PowerTimeSchemeResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/ProjectedAutoscaleMachines": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Gets the projected number of machines that Autoscale will keep powered on over the specified period", "operationId": "DeliveryGroups_GetDeiliveryGroupProjectedAutoscaleMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fromDate", "in": "query", "description": "Gets projected Autoscale machines for the period starting at the specified UTC date.\nspecify the date in this format:\nFor example, yyyy-MM-dd'T'HH:mm:ssZ.", "schema": { "title": "DateTime", "type": "string", "format": "date-time", "nullable": true }, "x-position": 2 }, { "name": "numberOfDays", "in": "query", "description": "Gets projected Autoscale machines for the period consisting of the specified number of days.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "The projected number of machines over the specified period.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProjectedAutoscaleMachinesResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/RebootSchedules": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the reboot schedules associated with a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupRebootSchedules", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of reboot schedules returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of reboot schedules.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootScheduleResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Create a reboot schedule for a delivery group.", "operationId": "DeliveryGroups_CreateDeliveryGroupRebootSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "Details of the reboot schedule to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootScheduleRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The created reboot schedule.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootScheduleResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/RebootSchedules/{name}": { "head": { "tags": [ "DeliveryGroups APIs" ], "summary": "Check for the existence of a reboot schedule by name.", "description": "Check for the existence of a reboot schedule by name. Note that\nreboot schedule names must be unique within the site, so the\n`nameOrId` parameter does not affect whether the reboot schedule\nname is found.\n\nIf the name is found to be available, this returns 404 Not Found.\nIf a reboot schedule by that name exists and is associated with the\nspecified delivery group, this returns 204 No Content. If a reboot\nschedule by that name exists and is associated with a different\ndelivery group, this returns 303 See Other, and the `Location`\nresponse header refers to location of the reboot schedule with that\nname.", "operationId": "DeliveryGroups_CheckRebootScheduleNameExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Name of the reboot schedule.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/RebootSchedules/{scheduleNameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Delete a reboot schedule from a delivery group.", "operationId": "DeliveryGroups_DeleteDeliveryGroupRebootSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "scheduleNameOrId", "in": "path", "required": true, "description": "Name or ID of the reboot schedule.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the details about a single reboot schedule associated\nwith a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupRebootSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "scheduleNameOrId", "in": "path", "required": true, "description": "Name or ID of the reboot schedule.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details about a reboot schedule.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootScheduleResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "DeliveryGroups APIs" ], "summary": "Update a reboot schedule for a delivery group.", "operationId": "DeliveryGroups_PatchDeliveryGroupRebootSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "scheduleNameOrId", "in": "path", "required": true, "description": "Name or ID of the reboot schedule to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the update request.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootScheduleRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "The updated reboot schedule.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootScheduleResponseModel" } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/StartMenuApplications": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the start menu applications from a machine in the delivery group.", "description": "Get the start menu applications from a machine in the delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupStartMenuApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagRestriction", "in": "query", "description": "The tag name for restriction.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the start menu applications will be queried as a background task.\nThis is recommended as this operation may cause a power action, turning on a\nmachine in order to gather the data. This may take some time to run, and if it\nexceeds 90 seconds the request may time out.\nThe task will have JobType GetStartMenuApplications.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the delivery group from which start menu applications are being obtained,\n* _Name_ - Name of the delivery group from which start menu applications are being obtained.\n* _MachineId_ - ID of the machine selected, from which the start menu applications are being obtained; will be present in Parameters only after a machine is selected.\n* _MachineName_ - Name of the machine selected, from which the start menu applications are being obtained; will be present in Parameters only after a machine is selected.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of start menu applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartMenuApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Tags": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get tags associated with a delivery group.", "description": "Get tags associated with a delivery group. This includes tags which are\ndirectly associated with the delivery group, as well as tags associated with\napplication groups, machines, or applications that are associated with the\ndelivery group. To find only tags directly associated with the delivery\ngroup, filter the results to those with\nNumDeliveryGroups equal to `1`.", "operationId": "DeliveryGroups_GetDeliveryGroupTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "Optional parameter, removing unspecified properties that otherwise would have been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Name,Id,Description" }, { "name": "async", "in": "query", "description": "If `true`, this request will be handled asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of tags.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "DeliveryGroups APIs" ], "summary": "Set tags associated with a delivery group.", "operationId": "DeliveryGroups_SetDeliveryGroupTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the tags to set on the delivery group.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Tags/{tagNameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Remove a tag from a delivery group.", "description": "Remove a tag from a delivery group. Does not delete the tag,\nonly its association to the delivery group.", "operationId": "DeliveryGroups_RemoveDeliveryGroupTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Add a tag to a delivery group.", "operationId": "DeliveryGroups_AddDeliveryGroupTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag to add.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "List of tags associated with the delivery group.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/TestReport": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the most recent test report of a delivery group.", "description": "Get the test report from the last run of\nTestDeliveryGroup.", "operationId": "DeliveryGroups_GetDeliveryGroupTestReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Last test report. If no tests have been run, returns a 404\nNot Found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/{nameOrId}/Usage": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get usage data about a delivery group.", "operationId": "DeliveryGroups_GetDeliveryGroupsUsage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the delivery group. If the delivery group is present in a delivery group folder,\n specify the name in this format: {delivery group folder path plus delivery group name}.\n For example, FolderName1|FolderName2|DeliveryGroupName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of usage data items returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of usage data.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DesktopUsageResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/AutoscalePlugin/{type}/Templates": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Return all autoscale plugin configuration templates for the specified plugin type.", "operationId": "DeliveryGroups_GetAutoscalePluginTemplates", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "type", "in": "path", "required": true, "description": "The type of the plugin.\n The supported types are: \"Holiday\", \"Intelligent\"\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If 'true', the templates will be gotten asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of the autoscale plugin configuration templates.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoscalePluginTemplateResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Create a new autoscale plugin configuration template for the specified plugin type.", "operationId": "DeliveryGroups_CreateAutoscalePluginTemplate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "type", "in": "path", "required": true, "description": "The type of the plugin.\n The supported types are: \"Holiday\", \"Intelligent\"\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If 'true', the template will be created asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "model", "description": "The template model.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateAutoscalePluginTemplateRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/AutoscalePlugin/{type}/Templates/{name}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Delete the autoscale plugin configuration template for the specified plugin type and name.", "operationId": "DeliveryGroups_DeleteAutoscalePluginTemplate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "type", "in": "path", "required": true, "description": "The type of the plugin.\n The supported types are: \"Holiday\", \"Intelligent\"\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "The name of the template.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If 'true', the template will be deleted asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Return the autoscale plugin configuration template for the specified plugin type and name.", "operationId": "DeliveryGroups_GetAutoscalePluginTemplate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "type", "in": "path", "required": true, "description": "The type of the plugin.\n The supported types are: \"Holiday\", \"Intelligent\"\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "The name of the template.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If 'true', the template will be gotten asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "The autoscale plugin configuration template.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoscalePluginTemplateResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "DeliveryGroups APIs" ], "summary": "Update the autoscale plugin configuration template for the specified plugin type.", "operationId": "DeliveryGroups_UpdateAutoscalePluginTemplate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "type", "in": "path", "required": true, "description": "The type of the plugin.\n The supported types are: \"Holiday\", \"Intelligent\"\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "The name of the template.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If 'true', the template will be created asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "model", "description": "The template model.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateAutoscalePluginTemplateRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/Desktops/{nameOrId}/Tags": { "get": { "tags": [ "DeliveryGroups APIs" ], "operationId": "DeliveryGroups_GetDesktopTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "DeliveryGroups APIs" ], "summary": "Set tags associated with a desktop( entitlement policy rule).", "operationId": "DeliveryGroups_SetDesktopTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the desktop.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the tags to set on the desktop.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/Desktops/{nameOrId}/Tags/{tagNameOrId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Remove a tag from a desktop( entitlement policy rule).", "description": "Remove a tag from a desktop( entitlement policy rule). Does not delete the tag,\nonly its association to the desktop.", "operationId": "DeliveryGroups_RemoveDesktopTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the desktop.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Add a tag to a desktop( entitlement policy rule).", "operationId": "DeliveryGroups_AddDesktopTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the desktop.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag to add.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "List of tags associated with the desktop.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/ResourceAccessPolicies": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the resource access policies in the site.", "operationId": "DeliveryGroups_GetResourceAccessPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "List of resource access policies in the site.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceAccessPolicyResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "DeliveryGroups APIs" ], "summary": "Create a resource access policy in the site.", "operationId": "DeliveryGroups_CreateResourceAccessPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the resource access policy will be created as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the resource access policy to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ResourceAccessPolicyRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "The created resource access policy.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceAccessPolicyResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroups/ResourceAccessPolicies/{policyId}": { "delete": { "tags": [ "DeliveryGroups APIs" ], "summary": "Delete a resource access policy in the site.", "operationId": "DeliveryGroups_DeleteResourceAccessPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyId", "in": "path", "required": true, "description": "UID of the resource access policy.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the resource access policy will be deleted as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get the details of a single resource access policy.", "operationId": "DeliveryGroups_GetResourceAccessPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyId", "in": "path", "required": true, "description": "UID of the resource access policy.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the access policy.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ResourceAccessPolicyResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "DeliveryGroups APIs" ], "summary": "Update a resource access policy in the site.", "operationId": "DeliveryGroups_PatchResourceAccessPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyId", "in": "path", "required": true, "description": "UID of the resource access policy.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the resource access policy will be updated as a background task. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the resource access policy to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ResourceAccessPolicyRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The updated resource access policy.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceAccessPolicyResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/DeliveryGroupsV2": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "The V2 version of get all delivery groups.", "description": "Get delivery groups in the site with default response fields if no fields parameters specified.", "operationId": "DeliveryGroups_GetDeliveryGroupsV2", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "adminFolder", "in": "query", "description": "Optional folder path (URL-encoded) or ID. If not specified, all delivery groups will\nbe returned from all folders.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of delivery groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5, "example": "Id,Uid,UserManagement" } ], "responses": { "200": { "description": "List of all delivery groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/comparePolicies": { "post": { "tags": [ "Gpo" ], "summary": "Compare policies. The policies can be from different policy sets.", "operationId": "Gpo_ComparePolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "withDefaults", "in": "query", "required": true, "description": "Include defaults in comparison", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "targets", "description": "GUIDs of policies", "content": { "application/json": { "schema": { "title": "Guid[]", "type": "array", "nullable": true, "items": { "title": "Guid", "type": "string", "format": "guid" } } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Comparison result", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparisonResponseContract" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/filterDefinitions": { "get": { "tags": [ "Gpo" ], "summary": "Get all filter definitions.", "operationId": "Gpo_GetFilterDefinitions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "Filter definitions", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelopeOfFilterDefinition" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/filters": { "get": { "tags": [ "Gpo" ], "summary": "Read filters defined in a policy. A policy in a policy set of type SiteTemplates or CustomTemplates does not\nhave filters.", "operationId": "Gpo_ReadGpoFilters", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyGuid", "in": "query", "required": true, "description": "The GUID of the policy from which filters are read", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "200": { "description": "The filters read", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelopeOfFilterResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Gpo" ], "summary": "Create a filter in a policy. Filters cannot be created in a policy in a policy set of type SiteTemplates or\nCustomTemplates.", "operationId": "Gpo_CreateGpoFilter", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyGuid", "in": "query", "required": true, "description": "The GUID of the policy to which the new filter belongs", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Filter data", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/FilterRequest" } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "The filter created", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/filters/$search": { "post": { "tags": [ "Gpo" ], "summary": "Perform an advanced search for GPO filters.", "operationId": "Gpo_SearchFilters", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a previous call didn't return all the records expected, pass the continuation token returned from the\nprevious response to this current query to continue retrieving the remaining objects.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the search operations will be executed as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/FilterSearch" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of policy sets that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CollectionEnvelopeOfFilterResponse" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/filters/{filterGuid}": { "delete": { "tags": [ "Gpo" ], "summary": "Delete an existing filter.", "operationId": "Gpo_DeleteGpoFilter", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "filterGuid", "in": "path", "required": true, "description": "The GUID of the filter to be deleted", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Gpo" ], "summary": "Read a specific filter.", "operationId": "Gpo_ReadGpoFilter", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "filterGuid", "in": "path", "required": true, "description": "The GUID of the filter to be read", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "200": { "description": "The filter read", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Gpo" ], "summary": "Update an existing filter.", "operationId": "Gpo_UpdateGpoFilter", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "filterGuid", "in": "path", "required": true, "description": "The GUID of the filter to be updated", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Filter data. The filter type is ignored", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/FilterRequest" } } }, "required": true, "x-position": 4 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policies": { "get": { "tags": [ "Gpo" ], "summary": "Read all policies defined in a policy set. Policy templates don't have filters.", "operationId": "Gpo_ReadGpoPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "query", "required": true, "description": "The GUID of the policy set from which policies are read", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 }, { "name": "withSettings", "in": "query", "description": "If set to true, settings in the policy are read", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 4 }, { "name": "withFilters", "in": "query", "description": "If set to true, filters in the policy are read", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "Collection of policies", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelopeOfPolicyResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Gpo" ], "summary": "Create a new policy. Policies cannot be created in the policy set of type SiteTemplates.", "operationId": "Gpo_CreateGpoPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "query", "required": true, "description": "GUID of the policy set in which the new policy is created", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Data for the new policy", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PolicyRequest" } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "The newly created policy", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policies/$copy": { "post": { "tags": [ "Gpo" ], "summary": "Copy some policies of a policy set to other policy sets.", "operationId": "Gpo_CopyGpoPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "withFilters", "in": "query", "required": true, "description": "Specify if policy filters should be included", "schema": { "title": "Boolean", "type": "boolean" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CopyPoliciesRequest" } } }, "required": true, "x-position": 4 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policies/$disable": { "post": { "tags": [ "Gpo" ], "summary": "Disable some policies of a policy set.", "operationId": "Gpo_DisableGpoPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "policyGuids", "description": "GUIDs of the policies to be disabled", "content": { "application/json": { "schema": { "title": "Guid[]", "type": "array", "nullable": true, "items": { "title": "Guid", "type": "string", "format": "guid" } } } }, "required": true, "x-position": 3 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policies/$enable": { "post": { "tags": [ "Gpo" ], "summary": "Enable some policies of a policy set.", "operationId": "Gpo_EnableGpoPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "policyGuids", "description": "GUIDs of the policies to be enabled", "content": { "application/json": { "schema": { "title": "Guid[]", "type": "array", "nullable": true, "items": { "title": "Guid", "type": "string", "format": "guid" } } } }, "required": true, "x-position": 3 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policies/$move": { "post": { "tags": [ "Gpo" ], "summary": "Move some policies of a policy set to another policy set.", "operationId": "Gpo_MoveGpoPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "toPolicySet", "in": "query", "required": true, "description": "GUID of the destination policy set", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "policyGuids", "description": "GUIDs of the policies to be removed", "content": { "application/json": { "schema": { "title": "Guid[]", "type": "array", "nullable": true, "items": { "title": "Guid", "type": "string", "format": "guid" } } } }, "required": true, "x-position": 4 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policies/$remove": { "post": { "tags": [ "Gpo" ], "summary": "Remove some policies of a policy set.", "operationId": "Gpo_RemoveGpoPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "policyGuids", "description": "GUIDs of the policies to be removed", "content": { "application/json": { "schema": { "title": "Guid[]", "type": "array", "nullable": true, "items": { "title": "Guid", "type": "string", "format": "guid" } } } }, "required": true, "x-position": 3 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policies/$search": { "post": { "tags": [ "Gpo" ], "summary": "Perform an advanced search for GPO policies.", "operationId": "Gpo_SearchPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a previous call didn't return all the records expected, pass the continuation token returned from the\nprevious response to this current query to continue retrieving the remaining objects.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the search operations will be executed as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PolicySearch" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of policy sets that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CollectionEnvelopeOfPolicyResponse" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policies/{policyGuid}": { "delete": { "tags": [ "Gpo" ], "summary": "Delete an existing GPO policy. A policy in the policy set of type SiteTemplates cannot be deleted. The\nUnfiltered policy in the policy set of type SitePolicies cannot be deleted.", "operationId": "Gpo_DeleteGpoPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyGuid", "in": "path", "required": true, "description": "GUID of the policy to be deleted", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Gpo" ], "summary": "Read a policy. A policy template doesn't have filters.", "operationId": "Gpo_ReadGpoPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyGuid", "in": "path", "required": true, "description": "GUID of the policy to be read", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 }, { "name": "withSettings", "in": "query", "description": "If set to true, read policy settings", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 4 }, { "name": "withFilters", "in": "query", "description": "If set to true, read policy filters", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "The policy read", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Gpo" ], "summary": "Update a policy. Only the policy body is updated.", "operationId": "Gpo_UpdateGpoPolicy", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyGuid", "in": "path", "required": true, "description": "GUID of the policy to be updated", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "New policy data", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PolicyBodyRequest" } } }, "required": true, "x-position": 4 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policyPriorities": { "post": { "tags": [ "Gpo" ], "summary": "Specify new priority order for all existing policies in a policy set. All the policies in the policy set must\nbe specified, even if the priorities of only some of the policies are changed.", "operationId": "Gpo_RankGpoPolicies", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "query", "required": true, "description": "Guid of the policy set that contains the policies", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "policyGuids", "description": "GUIDs of the policies to be re-prioritized", "content": { "application/json": { "schema": { "title": "List`1", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "Boolean", "type": "boolean" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policySets": { "get": { "tags": [ "Gpo" ], "summary": "Get all GPO policy sets in the site.", "operationId": "Gpo_ReadGpoPolicySets", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "The policy sets in the site", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelopeOfPolicySetResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Gpo" ], "summary": "Create a new GPO policy set. Only a policy set of type DeliveryGroupPolicies can be created.", "operationId": "Gpo_CreateGpoPolicySet", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "Parameters for the new policy set", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PolicySetRequest" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "The newly created policy set", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicySetResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policySets/$search": { "post": { "tags": [ "Gpo" ], "summary": "Perform an advanced search for GPO policy sets.", "operationId": "Gpo_SearchPolicySets", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a previous call didn't return all the records expected, pass the continuation token returned from the\nprevious response to this current query to continue retrieving the remaining objects.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the search operations will be executed as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PolicySetSearch" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of policy sets that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CollectionEnvelopeOfPolicySetResponse" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/policySets/{policySetGuid}": { "delete": { "tags": [ "Gpo" ], "summary": "Delete an existing GPO policy set. Only policy sets of type DeliveryGroupPolicies can be deleted. Policies in\nthe policy set are deleted if a policy set is deleted.", "operationId": "Gpo_DeleteGpoPolicySet", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "path", "required": true, "description": "The GUID of the policy set to be deleted", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Gpo" ], "summary": "Read a GPO policy set.", "operationId": "Gpo_ReadGpoPolicySet", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "path", "required": true, "description": "GUID of the policy set to read", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 }, { "name": "withPolicies", "in": "query", "description": "If set to true, read the policies in the policy set", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "The policy set read", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicySetResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Gpo" ], "summary": "Update an existing GPO policy set.", "operationId": "Gpo_UpdateGpoPolicySet", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "path", "required": true, "description": "The GUID of the policy set to update", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "New description of the policy set", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PolicySetRequest" } } }, "required": true, "x-position": 4 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Gpo" ], "summary": "Create a new GPO policy set by copying an existing policy set. The policies and settings in each policy are\ncopied to the new policy set. Optionally, the filters in the policies may be copied. Regardless of the type\nof the source policy set, the resulting policy set is always of type DeliveryGroupPolicies.", "operationId": "Gpo_CopyGpoPolicySet", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "path", "required": true, "description": "GUID of the existing policy set", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 }, { "name": "name", "in": "query", "required": true, "description": "The name of the new policy set", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "withFilters", "in": "query", "required": true, "description": "Indicate if filters in the policies should be copied", "schema": { "title": "Boolean", "type": "boolean" }, "x-position": 5 } ], "responses": { "200": { "description": "The newly created policy set", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicySetResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "Gpo" ], "summary": "Force serialization of policy set. The data of a policy set is serialized into a byte stream before it is\nsent to VDAs. The serialization is done automatically in the background at 5 minute intervals. A change made\nto the data in a policy set may not be in the serialized data for up to 5 minutes. This call tells the\nbackground thread to serialize the data immediately. No serialization is done if there have been no changes\nto the policy set data since the last time the data was serialized.", "operationId": "Gpo_UpdatePolicySetBlob", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "path", "required": true, "description": "The GUID of the policy set whose data is to be serialized", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/settingDefinitions": { "get": { "tags": [ "Gpo" ], "summary": "Get setting definitions. If isLean is set to true, only basic session information is returned. EnumType,\nVdaVersions, VersionDetails, and Explanation are not retrieved. If limit is set to -1 or a number larger\nthan the number of settings available, all entries are retrieved. If limit is set to a positive integer\nsmaller than the number of settings available, the specified number of settings are retrieved.", "operationId": "Gpo_GetSettingDefinitions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "isLean", "in": "query", "description": "Get lean parts of setting definitions, the default is set to true", "schema": { "title": "Boolean", "type": "boolean", "default": true, "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "Specify the number of entries to retrieve, the default is all entries", "schema": { "title": "Int32", "type": "integer", "format": "int32", "default": -1, "nullable": true }, "x-position": 4 }, { "name": "isAscending", "in": "query", "description": "Specify sort order, default is true", "schema": { "title": "Boolean", "type": "boolean", "default": true, "nullable": true }, "x-position": 5 }, { "name": "namePattern", "in": "query", "description": "Specify a regular expression to match the internal setting name. The default is match all names.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6 }, { "name": "isUserSetting", "in": "query", "description": "Specify the target of applying the settings. If it's set to true, only user settings are retrieved.\nIf it's set to false, only computer settings are retrieved. If not specified, both kinds of settings\nare retrieved. The default is to retrieve both kinds of settings.\n ", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 7 }, { "name": "continuationToken", "in": "query", "description": "Continuation token from a previous retrieval", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 8 } ], "responses": { "200": { "description": "Setting definitions", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDefinitionEnvelope" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/settingFullDetail": { "get": { "tags": [ "Gpo" ], "summary": "Get full detail of a setting definition.", "operationId": "Gpo_GetSettingFullDetail", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "settingName", "in": "query", "required": true, "description": "The internal name of the setting", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "All details of the setting definition", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingDefinition" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/settings": { "get": { "tags": [ "Gpo" ], "summary": "Read settings defined in a policy.", "operationId": "Gpo_ReadGpoSettings", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyGuid", "in": "query", "required": true, "description": "GUID of the policy from which settings are read", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "200": { "description": "The settings read", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionEnvelopeOfSettingResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Gpo" ], "summary": "Create a setting in a policy. Settings cannot be created in the policy set of type SiteTemplates.", "operationId": "Gpo_CreateGpoSetting", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policyGuid", "in": "query", "required": true, "description": "GUID of the policy to which the setting belongs", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Data for the new setting", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SettingRequest" } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "The newly created setting", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/settings/$search": { "post": { "tags": [ "Gpo" ], "summary": "Perform an advanced search for GPO settings.", "operationId": "Gpo_SearchSettings", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a previous call didn't return all the records expected, pass the continuation token returned from the\nprevious response to this current query to continue retrieving the remaining objects.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the search operations will be executed as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SettingSearch" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of policy sets that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CollectionEnvelopeOfSettingResponse" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/settings/{settingGuid}": { "delete": { "tags": [ "Gpo" ], "summary": "Delete a setting. Settings in the policy set of type SiteTemplates cannot be deleted.", "operationId": "Gpo_DeleteGpoSetting", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "settingGuid", "in": "path", "required": true, "description": "GUID of the setting to be deleted", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Gpo" ], "summary": "Read a specific setting.", "operationId": "Gpo_ReadGpoSetting", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "settingGuid", "in": "path", "required": true, "description": "GUID of the setting to be read", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "responses": { "200": { "description": "The setting read", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingResponse" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Gpo" ], "summary": "Update a setting. Settings in the policy set of type SiteTemplates cannot be updated.", "operationId": "Gpo_UpdateGpoSetting", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "settingGuid", "in": "path", "required": true, "description": "GUID of the setting to be updated", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "New setting value", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SettingRequest" } } }, "required": true, "x-position": 4 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/simulation": { "post": { "tags": [ "Gpo" ], "summary": "Simulate policy application.", "operationId": "Gpo_RunSimulation", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "policySetGuid", "in": "query", "required": true, "description": "The GUID of the policy set, on which this simulation is run", "schema": { "title": "Guid", "type": "string", "format": "guid" }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Modeling request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SimulationRequestContract" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Modeling result", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/SimulationResponseContract" } } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/gpo/validation": { "get": { "tags": [ "Gpo" ], "summary": "Check the site policies to ensure that they can be successfully converted to the new GPO objects. If an\nerror exists in the value of a setting or filter, the error must be fixed before the policy data can be\nconverted to new GPO setting, filter, and policy objects. The validation is done only on the site policies.", "operationId": "Gpo_RunValidation", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "all", "in": "query", "description": "If true, all settings and filters in the policies are returned, otherwise only settings and filters with\nerrors are returned. Policies are always included in the result, regardless of the value of this parameter.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "Site polices, as well as settings and filters in those policies.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/GpoTestPolicyData" } } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/HealthCheck": { "get": { "tags": [ "HealthCheck APIs" ], "summary": "The health check endpoint.", "operationId": "HealthCheck_HealthCheck", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "true or false", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "Boolean", "type": "boolean" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisorAllResourcePools": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the list of hypervisor resource pools from all hypervisors.", "description": "Get the list of hypervisor resource pools from all hypervisors.\nURI with ?noCache=true can ignore the cache and fetch the data directly.", "operationId": "Hypervisors_GetHypervisorAllResourcePools", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "Async request to get the resource pool. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "200": { "description": "List of hypervisor resource pools.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourcePoolResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisorResourcePoolAllAvailableNetworks": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get all available networks among hypervisors and resource pools.", "operationId": "Hypervisors_GetHypervisorResourcePoolAllAvailableNetworks", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If execute this API asynchronous. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of available networks. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourcePoolNetworkResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the hypervisors.", "description": "Get all hypervisors configured in the site.\nURI with ?noCache=true can ignore the cache and fetch the data directly.", "operationId": "Hypervisors_GetHypervisors", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "Async request to hypervisor. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "200": { "description": "List of hypervisors.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Hypervisors APIs" ], "summary": "Create a hypervisor, and optionally a resource pool on the hypervisor.", "description": "Create a hypervisor, and optionally a resource pool on the hypervisor.", "operationId": "Hypervisors_CreateHypervisor", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the hypervisor (and associated objects) will be created as a\nbackground task.\nThe task will have JobType CreateHypervisor.\nWhen the task is complete it will redirect to\nGetHypervisor.\nThe job's Parameters will contain properties:\n* _Name_ - Name of the hypervisor being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "model", "description": "Details of the hypervisor to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateHypervisorRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorDetailResponseModel" } } }, "x-expectedSchemas": [ { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAWSResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAzureResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailGCPResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailWOLResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailTraditionalResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOciResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOracleC3ResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAzureArcResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOpenShiftResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAWCResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailNutanixPCResponseModel" } }, { "description": "Details of the hypervisor that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/$GetResources": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Get all resources within a hypervisor, _without_ creating a\npersistent connection to the hypervisor.", "description": "Get the resources within a hypervisor, _without_ creating a\npersistent connection to the hypervisor. Note: in previous versions\nof the API, a \"Hypervisor\" was referred to as a \"Connection\".\nThis method is useful while determining the details required to\ncreate both a hypervisor and a resource pool, but without finalizing\nthe creation of either. The caller is free to browse resources that\nare available before deciding whether and how to proceed.\nA caller can recursively enumerate by:\n* Call with no `path`, and `children` equal to `1`.\n* For each of the result's\n Children where\n IsContainer is\n `true`, call with `path` equal to that item's\n RelativePath and\n `children` equal to `1`.\n * Repeat recursively.\nURI with ?force=true can get the VMs which provisioned by MCS.\nURI with ?recurse=true can recurse fetch all resources under this folder.", "operationId": "Hypervisors_GetHypervisorAllResourcesWithoutConnection", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "path", "in": "query", "description": "Path to the resource container within the hypervisor. The path may\neither be a relative path as specified by\nRelativePath, or\nmay be a URL-encoded Virtual Apps & Desktops resource path\nstarting with `XDHyp:`; for example, as specified by\nXDPath.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "children", "in": "query", "description": "Specifies the number of levels of children to enumerate.\nDefault is `0`, meaning that only the object referred to by `path`\nis returned and its\nChildren array will be\nleft null.\nA special value of `-1` indicates that the entire resource hierarchy\nshould be enumerated. Use with care! It may take a very long time\nto enumerate a large number of resources from a hypervisor, and the\ncall may time out before completing.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "type", "in": "query", "style": "form", "explode": true, "description": "If specified, limits the results to the specified resource type(s).", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 4 }, { "name": "showTagged", "in": "query", "description": "By default, items which are tagged by XenDesktop are not shown. Set\nthis to `true` to override that behavior.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 5 }, { "name": "detail", "in": "query", "description": "If `true`, full details of VMs, snapshots, and templates will be\nretrieved. This can be very time-consuming and will reduce the\nperformance of the call. May only be used if `path` refers to a VM,\nsnapshot, or template resource.\n", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 6 }, { "name": "async", "in": "query", "description": "Async request to get the resources with *path.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 7 }, { "name": "force", "in": "query", "description": "Get the VMs provisioned by MCS. ", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 8 }, { "name": "recurse", "in": "query", "description": "Fetch all resources under this folder. ", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 9 } ], "requestBody": { "x-name": "connectionDetail", "description": "Details of how to connect to the hypervisor to enumerate resources\nfrom it.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Cloud-based hypervisor's availability zone.\nor\nHypervisor GPU type resource.\nor\nHypervisor security group resource.\nor\nCloud-based hypervisor service offering.\nor\nHypervisor storage information.\nor\nCloud-based machine template.\nor\nVirtual machine.\nor\nVM/snapshot/template configuration.\nor\nCloud-based virtual private cloud.\nor\nHypervisor connection region.\nor\nA list of hypervisor resources.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourceResponseModel" } } }, "x-expectedSchemas": [ { "description": "Cloud-based hypervisor's availability zone.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel" } }, { "description": "Hypervisor GPU type resource.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorGpuTypeResourceResponseModel" } }, { "description": "Hypervisor security group resource.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorSecurityGroupResourceResponseModel" } }, { "description": "Cloud-based hypervisor service offering.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorServiceOfferingResourceResponseModel" } }, { "description": "Hypervisor storage information.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, { "description": "Cloud-based machine template.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorTemplateResourceResponseModel" } }, { "description": "Virtual machine.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVmResourceResponseModel" } }, { "description": "VM/snapshot/template configuration.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVmSnapshotResourceResponseModel" } }, { "description": "Cloud-based virtual private cloud.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVpcResourceResponseModel" } }, { "description": "Hypervisor connection region.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorCloudRegionResourceResponseModel" } }, { "description": "A list of hypervisor resources.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourceResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/$ValidateVm": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Validate a list of hypervisor Vm Path.", "description": "Validate a list of hypervisor Vm Path.", "operationId": "Hypervisors_ValidateVmPath", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the resource pool will be updated as a background task.\nThe task will have JobType HypervisorVmValidation.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "VmPaths", "description": "A list of Vm path.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVmValidationRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Details of the vm path validation results. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorVmValidationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{name}": { "head": { "tags": [ "Hypervisors APIs" ], "summary": "Check for the existence of a hypervisor by name.", "description": "Check for the existence of a hypervisor by name.", "operationId": "Hypervisors_CheckHypervisorExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}": { "delete": { "tags": [ "Hypervisors APIs" ], "summary": "Delete a hypervisor and related resource pools.", "operationId": "Hypervisors_DeleteHypervisor", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The hypervisor connection name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If the api call with async type. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the details for a single hypervisor.", "description": "Get the details for a single hypervisor.\nURI with ?noCache=true can ignore the cache and fetch the data directly.", "operationId": "Hypervisors_GetHypervisor", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "Async request to hypervisor. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "Hypervisor response object for AWS.\nor\nHypervisor response object for Azure.\nor\nHypervisor response object for GCP.\nor\nHypervisor response object for SCCM.\nor\nHypervisor response object.\nor\nHypervisor response object for OCI.\nor\nHypervisor response object for Oracle Compute Cloud@Customer.\nor\nHypervisor response object for Azure Arc.\nor\nHypervisor response object for OpenShift.\nor\nHypervisor response object for Amazon WorkSpaces Core.\nor\nHypervisor response object for Nutanic PC.\nor\nHypervisor details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorDetailResponseModel" } } }, "x-expectedSchemas": [ { "description": "Hypervisor response object for AWS.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAWSResponseModel" } }, { "description": "Hypervisor response object for Azure.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAzureResponseModel" } }, { "description": "Hypervisor response object for GCP.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailGCPResponseModel" } }, { "description": "Hypervisor response object for SCCM.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailWOLResponseModel" } }, { "description": "Hypervisor response object.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailTraditionalResponseModel" } }, { "description": "Hypervisor response object for OCI.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOciResponseModel" } }, { "description": "Hypervisor response object for Oracle Compute Cloud@Customer.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOracleC3ResponseModel" } }, { "description": "Hypervisor response object for Azure Arc.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAzureArcResponseModel" } }, { "description": "Hypervisor response object for OpenShift.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailOpenShiftResponseModel" } }, { "description": "Hypervisor response object for Amazon WorkSpaces Core.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailAWCResponseModel" } }, { "description": "Hypervisor response object for Nutanic PC.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailNutanixPCResponseModel" } }, { "description": "Hypervisor details.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorDetailResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Hypervisors APIs" ], "summary": "Update a hypervisor.", "description": "Update a hypervisor.", "operationId": "Hypervisors_PatchHypervisor", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the hypervisor will be updated as a background task.\nThe task will have JobType UpdateHypervisor.\nWhen the task is complete it will redirect to\nGetHypervisor.\nThe job's Parameters will contain properties:\n* _Name_ - Name of the hypervisor being updated.\n* _Id_ - ID of the hypervisor being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "model", "description": "Details of the hypervisor to update. Note that each type of\nhypervisor requires a different update model:\n* AWS requires a model of\ntype EditHypervisorAWSConnectionRequestModel.\n* AzureRM requires a model of\ntype EditHypervisorAzureConnectionRequestModel.\n* GoogleCloudPlatform\nrequires a model of type\nEditHypervisorGCPConnectionRequestModel.\n* OracleCloudInfrastructure\nrequires a model of type\nEditHypervisorOciConnectionRequestModel.\n* OracleC3\nrequires a model of type\nEditHypervisorOracleC3ConnectionRequestModel.\n* AzureArc\nrequires a model of type\nEditHypervisorAzureArcConnectionRequestModel.\n* OpenShift\nrequires a model of type\nEditHypervisorOpenShiftConnectionRequestModel.\n* AmazonWorkSpacesCore\nrequires a model of type\nEditHypervisorAWCConnectionRequestModel.\n* NutanixAhvPC\nrequires a model of type\nEditHypervisorNutanixPCConnectionRequestModel.\n* All other hypervisor types require a model of type\nEditHypervisorTraditionalConnectionRequestModel.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/$resetConnection": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Requests the broker hypervisor connection to be reset.\nThe connection is dropped, details including credentials refreshed and\nthe connection reestablished. The reset request is asynchronous and\nmay take a moment to occur.", "operationId": "Hypervisors_ResetBrokerHypervisorConnection", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Hypervisor connection name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If async calling. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Hypervisors/{nameOrId}/$test": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Run tests on a hypervisor and create a test report.", "description": "Run tests on a hypervisor and create a test report. Obtain the most\nrecent report from\nGetHypervisorTestReport.", "operationId": "Hypervisors_TestHypervisor", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor to test.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tests will run as a background task. This is recommended as the\ntests may take some time to run, and if it exceeds 90 seconds the request may\ntime out.\nThe task will have JobType TestHypervisor.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the hypervisor being tested,\n* _Name_ - Name of the hypervisor being tested.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "fields", "in": "query", "description": "A comma-separated list of properties to include in the response. For example, 'TestReport' to include the detailed test report.\nIf null or empty, a default set of properties will be returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Test response.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorTestResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/administrators": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get administrators who can administer a hypervisor.", "description": "Get administrators who can administer a hypervisor.", "operationId": "Hypervisors_GetHypervisorAdministrators", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If async execute. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of administrators returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "List of administrators.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/allResources": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get all resources within a hypervisor.", "description": "Get the resources within a hypervisor. Note: in previous versions\nof the API, this was referred to as a \"Connection\".\nA caller can recursively enumerate by:\n* Call with no `path`, and `children` equal to `1`.\n* For each of the result's\n Children where\n IsContainer is\n `true`, call with `path` equal to that item's\n RelativePath and\n `children` equal to `1`.\n* Repeat recursively.\nURI with ?noCache=true can ignore the cache and fetch the data directly.\nURI with ?force=true can get the VMs which provisioned by MCS.\nURI with ?recurse=true can recurse fetch all resources under this folder.", "operationId": "Hypervisors_GetHypervisorAllResources", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "path", "in": "query", "description": "Path to the resource container within the hypervisor. The path may\neither be a relative path as specified by\nRelativePath, or\nmay be a URL-encoded XenApp & XenDesktop resource path starting\nwith `XDHyp:`; for example, as specified by\nXDPath.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "children", "in": "query", "description": "Specifies the number of levels of children to enumerate.\nDefault is `0`, meaning that only the object referred to by `path`\nis returned and its\nChildren array will be left\nnull.\nA special value of `-1` indicates that the entire resource hierarchy\nshould be enumerated. Use with care! It may take a very long time\nto enumerate a large number of resources from a hypervisor, and the\ncall may time out before completing.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "type", "in": "query", "style": "form", "explode": true, "description": "If specified, limits the results to the specified resource type(s).", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 4 }, { "name": "showTagged", "in": "query", "description": "By default, items which are tagged by XenDesktop are not shown. Set\nthis to `true` to override that behavior.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 5 }, { "name": "detail", "in": "query", "description": "If `true`, full details of VMs, snapshots, and templates will be\nretrieved. This can be very time-consuming and will reduce the\nperformance of the call. May only be used if `path` refers to a VM,\nsnapshot, or template resource.\n", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 6 }, { "name": "async", "in": "query", "description": "Async request to get the resources with *path.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 7 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 8 }, { "name": "force", "in": "query", "description": "Get the VMs provisioned by MCS. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 9 }, { "name": "recurse", "in": "query", "description": "Fetch all resources under this folder. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 10 } ], "responses": { "200": { "description": "Cloud-based hypervisor's availability zone.\nor\nHypervisor GPU type resource.\nor\nHypervisor security group resource.\nor\nCloud-based hypervisor service offering.\nor\nHypervisor storage information.\nor\nCloud-based machine template.\nor\nVirtual machine.\nor\nVM/snapshot/template configuration.\nor\nCloud-based virtual private cloud.\nor\nHypervisor connection region.\nor\nA list of hypervisor resources.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourceResponseModel" } } }, "x-expectedSchemas": [ { "description": "Cloud-based hypervisor's availability zone.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel" } }, { "description": "Hypervisor GPU type resource.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorGpuTypeResourceResponseModel" } }, { "description": "Hypervisor security group resource.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorSecurityGroupResourceResponseModel" } }, { "description": "Cloud-based hypervisor service offering.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorServiceOfferingResourceResponseModel" } }, { "description": "Hypervisor storage information.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, { "description": "Cloud-based machine template.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorTemplateResourceResponseModel" } }, { "description": "Virtual machine.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVmResourceResponseModel" } }, { "description": "VM/snapshot/template configuration.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVmSnapshotResourceResponseModel" } }, { "description": "Cloud-based virtual private cloud.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVpcResourceResponseModel" } }, { "description": "Hypervisor connection region.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorCloudRegionResourceResponseModel" } }, { "description": "A list of hypervisor resources.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourceResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/allResources/$search": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Search the resources within a hypervisor.", "description": "Currently, support AWS, Azure, VCenter and Nutanix.", "operationId": "Hypervisors_DoHypervisorAllResourcesSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of resources returned by this query.\nIf not specified, the server might use a default limit of 1 item.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "detail", "in": "query", "description": "If `true`, full details of templates will be retrieved.\nThis can be very time-consuming and will reduce the\nperformance of the call.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 }, { "name": "async", "in": "query", "description": "Async request to get the resources with *path. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 6 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourceSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of hypervisor resource details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourceResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/connection": { "put": { "tags": [ "Hypervisors APIs" ], "summary": "Set the properties on a broker hypervisor connection.", "operationId": "Hypervisors_PutBrokerHypervisorConnection", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Hypervisor connection name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If async calling. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "model", "description": "EditBrokerHypervisorConnectionRequestModel or derived objects. ", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditBrokerHypervisorConnectionRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/deletePreview": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the hypervisor delete preview.", "description": "Get the machine catalogs and related info that are using a hypervisor.", "operationId": "Hypervisors_GetHypervisorDeletePreview", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If execute this API asynchronous. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "HypervisorDeletePreviewResponseModel object.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorDeletePreviewResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/jobs": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the currently active jobs that are using a hypervisor.", "description": "Get the currently active provisioning jobs that are using a hypervisor.", "operationId": "Hypervisors_GetHypervisorJobs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of machine catalogs that are using a hypervisor.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/machineCatalogs": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the machine catalogs that are using a hypervisor.", "description": "Get the machine catalogs that are using a hypervisor.", "operationId": "Hypervisors_GetHypervisorMachineCatalogs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If async execute. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of machine catalogs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "List of machine catalogs that are using a hypervisor.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorMachineCatalogResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Hypervisors/{nameOrId}/OrphanedResources": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Run detect on a hypervisor and retrieve orphaned resources.", "description": "Run detect on a hypervisor and get an orphaned resources result.", "operationId": "Hypervisors_GetHypervisorOrphanedResources", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor to detect.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tests will run as a background task. This is recommended as the\ntests may take some time to run, and if it exceeds 90 seconds the request may\ntime out.\n\n* _Id_ - ID of the hypervisor being detected,\n* _Name_ - Name of the hypervisor being detected.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Detect orphaned resource response.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetectOrphanedResourcesResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the list of hypervisor resource pools.", "description": "Get the list of hypervisor resource pools. Note: in previous versions of the API,\nresource pools were referred to as \"HostingUnits\".\nURI with ?noCache=true can ignore the cache and fetch the data directly.", "operationId": "Hypervisors_GetHypervisorResourcePools", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "Async request to get the resource pool. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "List of hypervisor resource pools.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourcePoolResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Hypervisors APIs" ], "summary": "Create a new resource pool on an existing hypervisor.", "description": "Create a new resource pool on an existing hypervisor.", "operationId": "Hypervisors_CreateResourcePool", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the resource pool (and associated objects) will be created as a\nbackground task.\nThe task will have JobType CreateHypervisorResourcePool.\nWhen the task is complete it will redirect to\nGetHypervisorResourcePool.\nThe job's Parameters will contain properties:\n* _Name_ - Name of the resource pool being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "model", "description": "Details of the resource pool to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateHypervisorResourcePoolRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" } } }, "x-expectedSchemas": [ { "description": "Details of the resource pool that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolAWSDetailResponseModel" } }, { "description": "Details of the resource pool that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolAzureDetailResponseModel" } }, { "description": "Details of the resource pool that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolGcpDetailResponseModel" } }, { "description": "Details of the resource pool that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolTraditionalDetailResponseModel" } }, { "description": "Details of the resource pool that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" } }, { "description": "Details of the resource pool that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolAWCDetailResponseModel" } }, { "description": "Details of the resource pool that was created.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolNutanixPCDetailResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{name}": { "head": { "tags": [ "Hypervisors APIs" ], "summary": "Check for the existence of a resource pool by name.", "description": "Check for the existence of a resource pool by name. Note that\nresource pool names must be unique within the site, so the\n`nameOrId` parameter does not affect whether the resource pool name\nis found.\nIf the name is found to be available, this returns 404 Not Found.\nIf a resource pool by that name exists and is associated with the\nspecified hypervisor, this returns 204 No Content. If a resource\npool by that name exists and is associated with a different\nhypervisor, this returns 303 See Other, and the `Location` response\nheader refers to location of the resource pool with that name.", "operationId": "Hypervisors_CheckHypervisorResourcePoolExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Name of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}": { "delete": { "tags": [ "Hypervisors APIs" ], "summary": "Delete a hypervisor resource pool.", "operationId": "Hypervisors_DeleteHypervisorResourcePool", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The name or id of hypervisor. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "The hypervisor resource pool id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If the api call with async type. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get details about a hypervisor resource pool.", "description": "Get details about a hypervisor resource pool. Note: in previous versions of\nthe API, resource pools were referred to as \"HostingUnits\".\nURI with ?noCache=true can ignore the cache and fetch the data directly.", "operationId": "Hypervisors_GetHypervisorResourcePool", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "Async request to get the resource pool. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 4 } ], "responses": { "200": { "description": "Pool of resources available on AWS hypervisor.\nor\nPool of resources available on Azure hypervisor.\nor\nPool of resources available on GCP hypervisor.\nor\nPool of resources available on Amazon WorkSpaces core hypervisor.\nor\nPool of resources available on Nutanix PC hypervisor.\nor\nPool of resources available on traditional hypervisor.\nor\nDetails about the hypervisor resource pool.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" } } }, "x-expectedSchemas": [ { "description": "Pool of resources available on AWS hypervisor.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolAWSDetailResponseModel" } }, { "description": "Pool of resources available on Azure hypervisor.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolAzureDetailResponseModel" } }, { "description": "Pool of resources available on GCP hypervisor.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolGcpDetailResponseModel" } }, { "description": "Pool of resources available on Amazon WorkSpaces core hypervisor.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolAWCDetailResponseModel" } }, { "description": "Pool of resources available on Nutanix PC hypervisor.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolNutanixPCDetailResponseModel" } }, { "description": "Pool of resources available on traditional hypervisor.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolTraditionalDetailResponseModel" } }, { "description": "Details about the hypervisor resource pool.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Hypervisors APIs" ], "summary": "Update a hypervisor resource pool.", "description": "Update a hypervisor resource pool.", "operationId": "Hypervisors_PatchHypervisorResourcePool", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the resource pool will be updated as a background task.\nThe task will have JobType UpdateHypervisorResourcePool.\nWhen the task is complete it will redirect to\nGetHypervisorResourcePool.\nThe job's Parameters will contain properties:\n* _Name_ - Name of the resource pool being updated.\n* _Id_ - ID of the resource pool being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "model", "description": "Details of the resource pool to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditHypervisorResourcePoolRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}/$getPatchPreview": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Get the hypervisor resource pool patch preview.", "operationId": "Hypervisors_GetHypervisorResourcePoolPatchPreview", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the preview job will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "model", "description": "New networks of the resource pool.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolPatchPreviewRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Reference of the networks.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourcePoolPatchPreviewResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Hypervisors/{nameOrId}/ResourcePools/{poolId}/$test": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Run tests on a resource pool and create a test report.", "description": "Run tests on a resource pool and create a test report. Obtain the most\nrecent report from\nGetHypervisorResourcePoolTestReport.", "operationId": "Hypervisors_TestHypervisorResourcePool", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor containing the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool to test.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tests will run as a background task. This is recommended as the\ntests may take some time to run, and if it exceeds 90 seconds the request may\ntime out.\nThe task will have JobType TestHypervisorResourcePool.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the resource pool being tested,\n* _Name_ - Name of the resource pool being tested.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "A comma-separated list of properties to include in the response. For example, 'TestReport' to include the detailed test report.\nIf null or empty, a default set of properties will be returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "Test response.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolTestResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}/administrators": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get administrators who can administer a resource pool.", "description": "Get administrators who can administer a resource pool.", "operationId": "Hypervisors_GetHypervisorResourcePoolAdministrators", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If async execute. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "The max number of administrators returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of administrators.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}/deletePreview": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the hypervisor resource pool delete preview.", "description": "Get the machine catalogs and related resources that are using by a resource pool.", "operationId": "Hypervisors_GetHypervisorResourcePoolDeletePreview", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If execute this API asynchronous. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "HypervisorDeletePreviewResponseModel object. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorDeletePreviewResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}/jobs": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the currently active jobs that are using a resource pool.", "description": "Get the currently active provisioning jobs that are using a resource pool.", "operationId": "Hypervisors_GetHypervisorResourcePoolJobs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of machine catalogs that are using a hypervisor.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}/machineCatalogs": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the machine catalogs that are using a resource pool.", "description": "Get the machine catalogs that are using a resource pool.", "operationId": "Hypervisors_GetHypervisorResourcePoolMachineCatalogs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If async execute. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "The max number of machine catalogs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of machine catalogs that are using a hypervisor.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorMachineCatalogResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}/resources": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the resources within a hypervisor resource pool.", "description": "Get the resources within a hypervisor resource pool. Note: in previous\nversions of the API, resource pools were referred to as \"HostingUnits\".\nA caller can recursively enumerate by:\n* Call with no `path`, and `children` equal to `1`.\n* For each of the result's\n Children where\n IsContainer is `true`, call\n with `path` equal to that item's\n RelativePath and `children`\n equal to `1`.\n* Repeat recursively.\nURI with ?noCache=true can ignore the cache and fetch the data directly.\nURI with ?force=true can get the VMs which provisioned by MCS.\nURI with ?recurse=true can recurse fetch all resources under this folder.", "operationId": "Hypervisors_GetHypervisorResourcePoolResources", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "path", "in": "query", "description": "Path to the resource container within the resource pool. The path may either\nbe a relative path as specified by\nRelativePath, or may be a\nURL-encoded XenApp & XenDesktop resource path starting with `XDHyp:`; for\nexample, as specified by\nXDPath.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "children", "in": "query", "description": "Specifies the number of levels of children to enumerate.\nDefault is `0`, meaning that only the object referred to by `path` is returned\nand its Children array will be\nleft null.\nA special value of `-1` indicates that the entire resource hierarchy should be\nenumerated. Use with care! It may take a very long time to enumerate a large\nnumber of resources from a hypervisor, and the call may time out before\ncompleting.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "type", "in": "query", "style": "form", "explode": true, "description": "If specified, limits the results to the specified resource type(s).", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 5 }, { "name": "showTagged", "in": "query", "description": "By default, items which are tagged by XenDesktop are not shown. Set this to\n`true` to override that behavior.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 6 }, { "name": "detail", "in": "query", "description": "If `true`, full details of VMs, snapshots, and templates will be retrieved.\nThis can be very time-consuming and will reduce the performance of the call.\nMay only be used if `path` refers to a VM, snapshot, or template resource.\n", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 7 }, { "name": "async", "in": "query", "description": "Async request to get the resources with *path. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 8 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 9 }, { "name": "force", "in": "query", "description": "Get the VMs provisioned by MCS. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 10 }, { "name": "recurse", "in": "query", "description": "Fetch all resources under this folder. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 11 } ], "responses": { "200": { "description": "Cloud-based hypervisor's availability zone.\nor\nHypervisor GPU type resource.\nor\nHypervisor security group resource.\nor\nCloud-based hypervisor service offering.\nor\nHypervisor storage information.\nor\nCloud-based machine template.\nor\nVirtual machine.\nor\nVM/snapshot/template configuration.\nor\nCloud-based virtual private cloud.\nor\nHypervisor connection region.\nor\nA list of hypervisor resources.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourceResponseModel" } } }, "x-expectedSchemas": [ { "description": "Cloud-based hypervisor's availability zone.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel" } }, { "description": "Hypervisor GPU type resource.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorGpuTypeResourceResponseModel" } }, { "description": "Hypervisor security group resource.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorSecurityGroupResourceResponseModel" } }, { "description": "Cloud-based hypervisor service offering.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorServiceOfferingResourceResponseModel" } }, { "description": "Hypervisor storage information.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, { "description": "Cloud-based machine template.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorTemplateResourceResponseModel" } }, { "description": "Virtual machine.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVmResourceResponseModel" } }, { "description": "VM/snapshot/template configuration.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVmSnapshotResourceResponseModel" } }, { "description": "Cloud-based virtual private cloud.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorVpcResourceResponseModel" } }, { "description": "Hypervisor connection region.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorCloudRegionResourceResponseModel" } }, { "description": "A list of hypervisor resources.", "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourceResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$search": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Search the resources within a hypervisor resource pool.", "description": "Currently, support AWS, Azure, VCenter and Nutanix.", "operationId": "Hypervisors_DoHypervisorResourceSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "The max number of resources returned by this query.\nIf not specified, the server might use a default limit of 1 item.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 }, { "name": "detail", "in": "query", "description": "If `true`, full details of templates will be retrieved.\nThis can be very time-consuming and will reduce the\nperformance of the call.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 6 }, { "name": "async", "in": "query", "description": "Async request to get the resources with *path. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 7 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourceSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "A list of hypervisor resources.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourceResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$validate": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Validate a resource for certain usages, currently default and only usage is for Machine Profile.", "operationId": "Hypervisors_ValidateHypervisorResourcePoolResource", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or id of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or id of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If async execute.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "More details attached to this validation.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourceValidationRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "The validation result.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourceValidationResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Hypervisors/{nameOrId}/ResourcePools/{poolId}/TestReport": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the most recent test report for a resource pool.", "description": "Get the test report from the last run of\nTestHypervisorResourcePool.", "operationId": "Hypervisors_GetHypervisorResourcePoolTestReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "poolId", "in": "path", "required": true, "description": "Name or ID of the resource pool.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Last test report. If no tests have been run, returns a 404 Not Found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/resourcePrices": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Get the hypervisor resource prices from settings.", "operationId": "Hypervisors_GetHypervisorResourcePrices", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The hypervisor connection name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If the api call with async type.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "model", "description": "The resource settings model.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourceSettingsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The hypervisor resource prices.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePricesResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/{nameOrId}/serverHAAddresses": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get hypervisor server HA addresses. Currently, it is only valid for Citrix hypervisors.", "description": "URI with ?noCache=true can ignore the cache and fetch the data directly.", "operationId": "Hypervisors_GetHypervisorServerHAAddresses", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The hypervisor connection name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If the execution with async model. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "HypervisorServerHAAddressesResponseModel object. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorServerHAAddressesResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Hypervisors/{nameOrId}/TestReport": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get the most recent test report for a hypervisor.", "description": "Get the test report from the last run of\nTestHypervisor.", "operationId": "Hypervisors_GetHypervisorTestReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the hypervisor.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Last test report. If no tests have been run, returns a 404 Not Found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/allResources/$search": { "post": { "tags": [ "Hypervisors APIs" ], "summary": "Search all resources within a hypervisor, _without_ creating a\npersistent connection to the hypervisor.", "operationId": "Hypervisors_DoHypervisorAllResourcesSearchWithoutConnection", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of resources returned by this query.\nIf not specified, the server might use a default limit of 1 item.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "detail", "in": "query", "description": "If `true`, full details of templates will be retrieved.\nThis can be very time-consuming and will reduce the\nperformance of the call.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "Async request to get the resources with *path. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "requestBody": { "x-name": "searchRequest", "description": "Contains hypervisor details and search criteria.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HypervisorAllResourceSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "A list of hypervisor resources.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorResourceResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisors/supportedPlugins": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get current server support hypervisors.", "description": "URI with ?noCache=true can ignore the cache and fetch the data directly.", "operationId": "Hypervisors_GetSupportHypervisors", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If execute this API asynchronous. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 }, { "name": "zoneNameOrId", "in": "query", "description": "The zone name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "includeUnavailable", "in": "query", "description": "Flag to show all supported hypervisor plugins.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 4 } ], "responses": { "200": { "description": "List of Hypervisor Plugin response model. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorPluginResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/hypervisorsAndResourcePools": { "get": { "tags": [ "Hypervisors APIs" ], "summary": "Get hypervisors and resource pools.\nThis API is used for the hosting main view.", "description": "URI with ?noCache=true can ignore the cache and fetch the data directly.", "operationId": "Hypervisors_GetHypervisorsAndResourcePools", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If execute this API asynchronous. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 }, { "name": "noCache", "in": "query", "description": "Disable the cache. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "200": { "description": "List of Hypervisor Main View Response Model. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HypervisorsAndResourcePoolsResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Icons": { "get": { "tags": [ "Icons APIs" ], "summary": "Get all icons in the site.", "description": "Get all icons in the site.", "operationId": "Icons_GetIcons", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "iconFormat", "in": "query", "description": "Icon format. Must be: `{mime-type};{width}x{height}x{colordepth}`\n\n\nwhere:\n\n\n* _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n* _width_ and _height_ are specified in pixels.\n* _colordepth_ (optional) is either `8` or `24`.\n\n\nexample: `\"image/png;32x32x24\"`\n\n\nOptional. If not specified, only the raw icon data will be returned. Note that\nthis is typically in ICO format, which some clients cannot display properly.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "builtIn", "in": "query", "description": "If specified as `true`, only built-in icons will be returned. If specified as\n`false`, only user-created icons will be returned. If not specified, all\nicons will be returned.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If async execute. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "The max number of icons returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of icons.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Icons APIs" ], "summary": "add a customized icon.", "operationId": "Icons_AddIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the icon will be added as a background task.\nThe task will have JobType AddIcon.\nWhen the task is complete it will redirect to\nGetIcon.\n ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "requestModel", "description": "request body containing icon data", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AddIconRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Icons/$discover": { "post": { "tags": [ "Icons APIs" ], "summary": "Search path for icon files to discover icons.", "operationId": "Icons_DiscoverIcons", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the search operation will run as a background task.\nThe task will have JobType IconDiscovery", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Search request for icons discovery. IconDiscoveryRequestModel", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/IconDiscoveryRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "The discovered icons information", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/IconDiscoveryResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Icons/{id}": { "delete": { "tags": [ "Icons APIs" ], "summary": "Remove a customized icon.", "operationId": "Icons_RemoveIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "id of the icon to remove", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the icon will be removed as a background task.\nThe task will have JobType RemoveIcon.\nWhen the task is complete it will redirect to\nGetIcons.\n ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Icons APIs" ], "summary": "Get a single icon from the site.", "description": "Get a single icon from the site", "operationId": "Icons_GetIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the icon.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "iconFormat", "in": "query", "description": "Icon format. Must be:\n`{mime-type};{width}x{height}x{colordepth}`\n\n\nwhere:\n* _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n* _width_ and _height_ are specified in pixels.\n* _colordepth_ (optional) is either `8` or `24`.\n example: `\"image/png;32x32x24\"`\n\n\nOptional. If not specified, only the raw icon data will be returned. Note that\nthis is typically in ICO format, which some clients cannot display properly.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "The icon.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Icons/AppVServerPackageApplication": { "post": { "tags": [ "Icons APIs" ], "summary": "Get the icon for a single App-V application within an App-V package\non a server.", "description": "Get the icon for a single App-V package on a server (as\nopposed to within the site).", "operationId": "Icons_GetAppVServerPackageApplicationIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "App-V server package application icon request model.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AppvServerPackageApplicationIconRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Icon details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconDataResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/AzureADTenants/{azureAdTenantId}/AzureADSecurityGroups": { "get": { "tags": [ "Identity APIs" ], "summary": "Query Microsoft Entra ID security group by user's input.", "description": "When user's input all are empty, then all those assigned security group in a specific tenant it will be retrieved.", "operationId": "Identity_QueryAzureAdSecurityGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AccessToken", "in": "header", "description": "Access token to use when performing the operation. If specified, must be in a format matching that of the standard 'Authorization' request header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "azureAdTenantId", "in": "path", "required": true, "description": "The specific azure tenant id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "name", "in": "query", "description": "Specific the group display name.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "assigned", "in": "query", "description": "When name is empty, assigned only support the value of true.", "schema": { "title": "Boolean", "type": "boolean", "default": true, "nullable": true }, "x-position": 3 }, { "name": "maxCount", "in": "query", "description": "The max return count,default is 300.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "serviceAccountUid", "in": "query", "description": "The service account uid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AzureADSecurityGroupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/AzureADTenants/{azureAdTenantId}/AzureADSecurityGroups/{groupId}": { "get": { "tags": [ "Identity APIs" ], "summary": "Get Microsoft Entra ID security group by group id.", "description": "Retrieves Microsoft Entra ID's security groups by user's input.", "operationId": "Identity_GetAzureADSecurityGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AccessToken", "in": "header", "description": "Access token to use when performing the operation. If specified, must be in a format matching that of the standard 'Authorization' request header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "azureAdTenantId", "in": "path", "required": true, "description": "Microsoft Entra tenant Id", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "groupId", "in": "path", "required": true, "description": "Microsoft Entra ID security group's objectId", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "serviceAccountUid", "in": "query", "description": "Service account objectId", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of Microsoft Entra ID security groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AzureADSecurityGroupResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/AzureADTenants/{azureAdTenantId}/AzureADSecurityGroups/{groupId}/members": { "get": { "tags": [ "Identity APIs" ], "summary": "Retrieves all the group type of members of a specific group", "operationId": "Identity_GetAzureAdSecurityGroupMember", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AccessToken", "in": "header", "description": "Access token to use when performing the operation. If specified, must be in a format matching that of the standard 'Authorization' request header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "azureAdTenantId", "in": "path", "required": true, "description": "The Azure tenant id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "groupId", "in": "path", "required": true, "description": "The security group object id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "type", "in": "query", "description": "Only type=group is support now.", "schema": { "title": "String", "type": "string", "default": "group", "nullable": true }, "x-position": 3 }, { "name": "maxCount", "in": "query", "description": "The max return records number.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "serviceAccountUid", "in": "query", "description": "The service account uid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AzureADSecurityGroupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/AzureADTenants/{azureAdTenantId}/AzureADSecurityGroups/{groupId}/members/{refGroupId}": { "put": { "tags": [ "Identity APIs" ], "summary": "Add a security group to an assigned security as it's member", "operationId": "Identity_AddAzureAdSecurityGroupMember", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AccessToken", "in": "header", "description": "Access token to use when performing the operation. If specified, must be in a format matching that of the standard 'Authorization' request header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "azureAdTenantId", "in": "path", "required": true, "description": "The Azure tenant id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "groupId", "in": "path", "required": true, "description": "The parent assigned security group object id", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "refGroupId", "in": "path", "required": true, "description": "The nested devices security group object id", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "serviceAccountUid", "in": "query", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Containers": { "get": { "tags": [ "Identity APIs" ], "summary": "Get containers from identity provider.", "description": "Get containers from identity provider", "operationId": "Identity_GetContainers", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "forest", "in": "query", "description": "Forest to get containers from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "domain", "in": "query", "description": "Domain to get containers from. If not specified, all domains in the forest(s) are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "container", "in": "query", "style": "form", "explode": true, "description": "Specific container(s) to filter the results to. If not specified, all matching containers are returned. If set, `recursive` parameter is ignored and is implied `true`.", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 3 }, { "name": "startsWith", "in": "query", "description": "Search for containers that start with a string. If not specified, all matching containers are returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "contains", "in": "query", "description": "Search for containers that contain a string. If not specified, all matching containers are returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 }, { "name": "matches", "in": "query", "description": "Search for containers that match a string. If not specified, all matching containers are returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6 }, { "name": "parentOU", "in": "query", "description": "The parent OU to search. If not specified, will search from the root OU.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 7 }, { "name": "recursive", "in": "query", "description": "Indicates whether the search should be recursive. Default is `false`.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 8 }, { "name": "containerType", "in": "query", "style": "form", "explode": true, "description": "Indicates container type(s) that should be retrieved. If not specified, all container types will be searched.", "schema": { "title": "IdentityContainerType[]", "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityContainerType" } }, "x-position": 9 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 10 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 11 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return. If more items are available, a continuation token will\nbe returned. If not specified, all items will be returned.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 12 }, { "name": "continuationToken", "in": "query", "description": "If specified, a previous query will be continued. The caller must specify the same query parameters\nand admin credentials as the initial query or else the behavior is undefined.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 13 } ], "responses": { "200": { "description": "List of containers.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityContainerResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Containers/{container}": { "get": { "tags": [ "Identity APIs" ], "summary": "Get a single container (e.g. OU)", "description": "Get a single container (e.g. OU).", "operationId": "Identity_GetContainer", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "container", "in": "path", "required": true, "description": "Container to get.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "forest", "in": "query", "description": "Forest to get container from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "domain", "in": "query", "description": "Domain to get container from. If not specified, all domains in the forest(s) are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "Details about container.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityContainerResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Directories": { "get": { "tags": [ "Identity APIs" ], "summary": "Get list of directories from all identity providers", "description": "Get list of directories from all identity providers.", "operationId": "Identity_GetDirectories", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "provider", "in": "query", "description": "Provider to get directories from.", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/IdentityProviderType" } ] }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of items returned by this query.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of directories.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityDirectoryResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Domains": { "get": { "tags": [ "Identity APIs" ], "summary": "Get list of domains from the identity provider", "description": "Get list of domains from the identity provider.", "operationId": "Identity_GetDomains", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "forest", "in": "query", "description": "Forest to get domains from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "domain", "in": "query", "style": "form", "explode": true, "description": "Specific domain(s) to filter the results to. If not specified, all matching domains are returned.", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 2 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "parentDomain", "in": "query", "description": "Parent domain name to search. Default is the root domain of the forest.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "recursive", "in": "query", "description": "Specifies whether the search is recursive.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 5 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values of the properties. If not specified,\nall properties other than IdentityDomainProperty.Controllers IdentityDomainProperty.PrimaryController will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 6 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return. If more items are available, a continuation token will\nbe returned. If not specified, all items will be returned.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 7 }, { "name": "continuationToken", "in": "query", "description": "If specified, a previous query will be continued. The caller must specify the same query parameters\nand admin credentials as the initial query or else the behavior is undefined.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 8 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 9 } ], "responses": { "200": { "description": "List of domains.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityDomainResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Domains/{domain}": { "get": { "tags": [ "Identity APIs" ], "summary": "Get a single domain from the identity provider", "description": "Get a single domain from the identity provider.", "operationId": "Identity_GetDomain", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "domain", "in": "path", "required": true, "description": "Domain to get details from.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "forest", "in": "query", "description": "Forest to get domain from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values of the properties. If not specified,\nall properties other than IdentityDomainProperty.Controllers IdentityDomainProperty.PrimaryController will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "Details about a domain.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityDomainResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Domains/{domain}/AzureADCustomDomain": { "get": { "tags": [ "Identity APIs" ], "summary": "Gets the Microsoft Entra ID custom domain with the specified domain name.", "operationId": "Identity_GetDomainAzureADCustomDomain", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "domain", "in": "path", "required": true, "description": "Domain name.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The Microsoft Entra ID custom domain with the specified domain name.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AzureADCustomDomainResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Forests": { "get": { "tags": [ "Identity APIs" ], "summary": "Get the list of forests from the identity provider", "description": "Get the list of forests from the identity provider.", "operationId": "Identity_GetForests", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "forest", "in": "query", "style": "form", "explode": true, "description": "Specific forest(s) to filter the results to. If not specified, all forests are returned.", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 1 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return. If more items are available, a continuation token will\nbe returned. If not specified, all items will be returned.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If specified, a previous query will be continued. The caller must specify the same query parameters\nand admin credentials as the initial query or else the behavior is undefined.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "refreshCache", "in": "query", "description": "refresh forest FMA cache only applicable for cloud", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 5 }, { "name": "async", "in": "query", "description": "If `true`, get forests will be created as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 6 } ], "responses": { "200": { "description": "List of forests.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityForestResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Forests/{forest}": { "get": { "tags": [ "Identity APIs" ], "summary": "Get information about a single forest", "description": "Get information about a single forest.", "operationId": "Identity_GetForest", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "forest", "in": "path", "required": true, "description": "forest", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details about a forest.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityForestResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Machines": { "get": { "tags": [ "Identity APIs" ], "summary": "Get machine accounts from identity provider", "description": "Get machine accounts from identity provider.", "operationId": "Identity_GetMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "forest", "in": "query", "description": "Forest to get machine accounts from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "domain", "in": "query", "description": "Domain to get machine accounts from. If not specified, all domains in the forest(s) are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "machine", "in": "query", "style": "form", "explode": true, "description": "Specific machine(s) to filter the results to. If not specified, all matching machines are returned. If set, `recursive` parameter is ignored and is implied `true`.", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 3 }, { "name": "startsWith", "in": "query", "description": "Search for machine accounts that start with a string. This parameter is exclusive with `contains`, and `matches`.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "contains", "in": "query", "description": "Search for machine accounts that contain a string. This parameter is exclusive with `startsWith`, and `matches`.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 }, { "name": "matches", "in": "query", "description": "Search for machine accounts that match a string. This parameter is exclusive with `startsWith`, and `contains`.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6 }, { "name": "parentOU", "in": "query", "description": "The parent OU to search. If not specified, will search from the root OU.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 7 }, { "name": "recursive", "in": "query", "description": "Indicates whether the search should be recursive.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 8 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 9 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties other than\nIPAddress will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 10 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return. If more items are available, a continuation token will\nbe returned. If not specified, all items will be returned.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 11 }, { "name": "continuationToken", "in": "query", "description": "If specified, a previous query will be continued. The caller must specify the same query parameters\nand admin credentials as the initial query or else the behavior is undefined.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 12 } ], "responses": { "200": { "description": "List of machines.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityMachineResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Identity APIs" ], "summary": "Create machine identity", "description": "Create machine identity.", "operationId": "Identity_CreateMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the machine identity will be created as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the machine identity to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/IdentityCreateMachineRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "The newly created machine identity.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityMachineResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Machines/{machine}": { "delete": { "tags": [ "Identity APIs" ], "summary": "Delete a machine identity", "description": "Delete a machine identity.", "operationId": "Identity_DeleteMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "machine", "in": "path", "required": true, "description": "Machine identity to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "forest", "in": "query", "required": true, "description": "Forest to delete machine account from. Required.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "domain", "in": "query", "required": true, "description": "Domain to delete machine account from. Required.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the machine identity will be deleted as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Identity APIs" ], "summary": "Get a single machine account from identity provider", "description": "Get a single machine account from identity provider.", "operationId": "Identity_GetMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "machine", "in": "path", "required": true, "description": "Machine to get.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "forest", "in": "query", "description": "Forest to get machine account from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "domain", "in": "query", "description": "Domain to get machine account from. If not specified, all domains in the forest(s) are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties other than\nIPAddress will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "Details about the machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityMachineResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Identity APIs" ], "summary": "Update a machine identity", "description": "Update a machine identity.", "operationId": "Identity_UpdateMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "machine", "in": "path", "required": true, "description": "Machine identity to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "forest", "in": "query", "required": true, "description": "Forest to update machine account within. Required.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "domain", "in": "query", "required": true, "description": "Domain to update machine account within. Required.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 }, { "name": "async", "in": "query", "description": "If `true`, the machine identity will be updated as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 6 } ], "requestBody": { "x-name": "request", "description": "Properties of the machine identity that should be updated.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/IdentityUpdateMachineRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Details about a machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityMachineResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Printers": { "get": { "tags": [ "Identity APIs" ], "summary": "Get network printers from identity provider", "description": "Get network printers from identity provider.", "operationId": "Identity_GetPrinters", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "forest", "in": "query", "description": "Forest to get printers from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "domain", "in": "query", "description": "Domain to get printers from. If not specified, all domains in the forest(s) are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "server", "in": "query", "description": "Printer server name", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "uncpath", "in": "query", "description": "Printer UNC path", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the get printers will be executed as a background task.\nThe task will have JobType GetPrintersIdentity.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of printers.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityPrinterResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/ServiceAccount": { "post": { "tags": [ "Identity APIs" ], "summary": "Create a service account async.", "operationId": "Identity_CreateServiceAccount", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, this will be queried as a background task.\nThe task will have JobType CreateServiceAccount.\nWhen the task is complete it will redirect to GetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "The object of CreateServiceAccountRequestModel used to create a service account. ", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateServiceAccountRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "The created service account.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/ServiceAccount/{serviceAccountUid}": { "delete": { "tags": [ "Identity APIs" ], "summary": "Delete an existing service account.", "operationId": "Identity_DeleteServiceAccount", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "serviceAccountUid", "in": "path", "required": true, "description": "The ServiceAccountUid of an existing service account. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Identity APIs" ], "summary": "Get a specific service account.", "operationId": "Identity_GetServiceAccount", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "serviceAccountUid", "in": "path", "required": true, "description": "The ServiceAccountUid of a specific service account. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The specific service account.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Identity APIs" ], "summary": "Set properties of an existing service account.", "operationId": "Identity_SetServiceAccount", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "serviceAccountUid", "in": "path", "required": true, "description": "The ServiceAccountUid of service account. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, this will be queried as a background task.\n The task will have JobType SetServiceAccount.\n When the task is complete it will redirect to GetJobResults.\n ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The object of UpdateServiceAccountRequestModel used to set an existing service account. ", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateServiceAccountRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The service account after modification.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/serviceAccount/{serviceAccountUid}/$getPatchPreview": { "post": { "tags": [ "Identity APIs" ], "summary": "Get the service account capability patch preview.", "description": "Get the service account capability patch preview before updating the service account.\nSetServiceAccount.", "operationId": "Identity_GetServiceAccountCapabilityPatchPreview", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "serviceAccountUid", "in": "path", "required": true, "description": "ID of the service account to test.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the get preview patch will run as a background task. This is recommended as the\ngets may take some time to run, and if it exceeds 90 seconds the request may\ntime out.\nThe task will have JobType GetPatchPreviewServiceAccount.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the service account being update.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "requestModel", "description": "Update serivce account capability preview request model.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateServiceAccountCapabilityPreviewRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Update service account capability preview response.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServiceAccountCapabilityPreviewResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/serviceAccount/{serviceAccountUid}/$test": { "post": { "tags": [ "Identity APIs" ], "summary": "Run tests on a service account and create a test report.", "description": "Run tests on a service account and create a test report. Obtain the most\nrecent report from\nGetServiceAccountTestReport.", "operationId": "Identity_TestServiceAccount", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "serviceAccountUid", "in": "path", "required": true, "description": "ID of the service account to test.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tests will run as a background task. This is recommended as the\ntests may take some time to run, and if it exceeds 90 seconds the request may\ntime out.\nThe task will have JobType TestServiceAccount.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the service account being tested,", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "fields", "in": "query", "description": "A comma-separated list of properties to include in the response. For example, 'TestReport' to include the detailed test report.\nIf null or empty, a default set of properties will be returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Test response.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ServiceAccountTestResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/serviceAccount/{serviceAccountUid}/testReport": { "get": { "tags": [ "Identity APIs" ], "summary": "Get the most recent test report for a service account.", "description": "Get the test report from the last run of\nTestServiceAccount.", "operationId": "Identity_GetServiceAccountTestReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "serviceAccountUid", "in": "path", "required": true, "description": "ID of the service account.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Last test report. If no tests have been run, returns a 404 Not Found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/ServiceAccounts": { "get": { "tags": [ "Identity APIs" ], "summary": "Get all service accounts.", "operationId": "Identity_GetServiceAccounts", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "All existing service accounts.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Sites": { "get": { "tags": [ "Identity APIs" ], "summary": "Get list of sites from the identity provider", "description": "Get list of sites from the identity provider.", "operationId": "Identity_GetSites", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "forest", "in": "query", "description": "Forest to get sites from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "domain", "in": "query", "description": "Domain to get sites from. If not specified, all domains in the forest(s) are queried.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "hostNameOrIP", "in": "query", "description": "Hostname or IP to get sites from.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "site", "in": "query", "style": "form", "explode": true, "description": "Specific site(s) to filter the results to. If not specified, all matching sites are returned.", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 4 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 5 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return. If more items are available, a continuation token will\nbe returned. If not specified, all items will be returned.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 6 }, { "name": "continuationToken", "in": "query", "description": "If specified, a previous query will be continued. The caller must specify the same query parameters\nand admin credentials as the initial query or else the behavior is undefined.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 7 } ], "responses": { "200": { "description": "List of sites.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentitySiteResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Sites/{site}": { "get": { "tags": [ "Identity APIs" ], "summary": "Get information about a single site", "description": "Get information about a single site.", "operationId": "Identity_GetSite", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "site", "in": "path", "required": true, "description": "The site to get details for.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "forest", "in": "query", "description": "Forest to get the site from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "domain", "in": "query", "description": "Domain to get the site from. If not specified, all domains in the forest(s) are queried until the site is found.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "Details about a site.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentitySiteResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Trusts": { "get": { "tags": [ "Identity APIs" ], "summary": "Get trust info from current forest and domains in current forest", "description": "Get trust info from current forest and domains in current forest", "operationId": "Identity_GetTrusts", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "List of trust info of current forest and domains in current forest.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityTrustResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Users": { "get": { "tags": [ "Identity APIs" ], "summary": "Get users from identity provider", "description": "Get users from identity provider.", "operationId": "Identity_GetUsers", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "provider", "in": "query", "description": "Provider to get users from.", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/IdentityProviderType" } ] }, "x-position": 1 }, { "name": "forest", "in": "query", "description": "Forest to get users from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "domain", "in": "query", "description": "Domain to get users from. If not specified, all domains in the forest(s) are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "tenant", "in": "query", "description": "Tenant to get users from.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "user", "in": "query", "style": "form", "explode": true, "description": "Specific user(s) to filter the results to. If not specified, all matching users are returned. If set, `recursive` parameter is ignored and is implied `true`.", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 5 }, { "name": "startsWith", "in": "query", "description": "Search for users that start with a string. This parameter is exclusive with `contains`, and `matches`.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6 }, { "name": "contains", "in": "query", "description": "Search for users that contain a string. This parameter is exclusive with `startsWith`, and `matches`.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 7 }, { "name": "matches", "in": "query", "description": "Search for users that match a string. This parameter is exclusive with `startsWith`, and `contains`.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 8 }, { "name": "parentOU", "in": "query", "description": "The parent OU to search. If not specified, will search from the root OU.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 9 }, { "name": "recursive", "in": "query", "description": "Indicates whether the search should be recursive.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 10 }, { "name": "userType", "in": "query", "description": "Indicates user type(s) that should be retrieved. If not specified, all user types will be searched.", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/IdentityUserType" } ] }, "x-position": 11 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 12 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 13 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return. If more items are available, a continuation token will\nbe returned. If not specified, all items will be returned.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 14 }, { "name": "continuationToken", "in": "query", "description": "If specified, a previous query will be continued. The caller must specify the same query parameters\nand admin credentials as the initial query or else the behavior is undefined.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 15 }, { "name": "async", "in": "query", "description": "If `true`, the get users will be executed as a background task.\nThe task will have JobType GetUsersIdentity.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 16 }, { "name": "idpInstanceId", "in": "query", "description": "Instance id of the identity provider.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 17 }, { "name": "includeIdentityClaims", "in": "query", "description": "Include the identity claims in the results.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 18 } ], "responses": { "200": { "description": "List of users.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityUserResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Users/$validate": { "post": { "tags": [ "Identity APIs" ], "summary": "Validate a user's credentials", "description": "Validate a user's credentials, and if valid, get information about the user account.", "operationId": "Identity_ValidateUser", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "Details of the user credentials to validate.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/IdentityValidateUserRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Details of the user.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityUserResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Users/{user}": { "patch": { "tags": [ "Identity APIs" ], "summary": "Update a user identity", "description": "Update a user identity.", "operationId": "Identity_UpdateUser", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "user", "in": "path", "required": true, "description": "User identity to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "forest", "in": "query", "required": true, "description": "Forest to update user account within. Required.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "domain", "in": "query", "required": true, "description": "Domain to update user account within. Required.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 }, { "name": "async", "in": "query", "description": "If `true`, the user identity will be updated as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 6 } ], "requestBody": { "x-name": "request", "description": "Properties of the user identity that should be updated.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/IdentityUpdateUserRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Details about a user.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityUserResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Identity/Users/{userOrGroup}": { "get": { "tags": [ "Identity APIs" ], "summary": "Get a single user or group", "description": "Get a single user or group.", "operationId": "Identity_GetUser", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "userOrGroup", "in": "path", "required": true, "description": "Identity of the user or group to get.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "forest", "in": "query", "description": "Forest to get users from. If not specified, all forests are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "domain", "in": "query", "description": "Domain to get users from. If not specified, all domains in the forest(s) are queried, which may take a long time.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "directoryServerHint", "in": "query", "description": "Hint to inform the system of a directory server which is most likely to successfully perform the operation.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "propertiesToRetrieve", "in": "query", "description": "Properties to retrieve. This should be specified as an integer representing the OR-ed together values\nof the properties. If not specified, all properties will be retrieved.", "schema": { "title": "UInt32", "type": "integer", "default": 2147483647, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "User or group details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityUserResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageDefinitions": { "get": { "tags": [ "ImageDefinitions APIs" ], "summary": "Get all image definitions.", "operationId": "ImageDefinitions_GetImageDefinitions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of image definitions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of image definitions.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageDefinitionResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "ImageDefinitions APIs" ], "summary": "Create an image definition.", "operationId": "ImageDefinitions_CreateImageDefinition", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "Create image definition async", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details about the image definition to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateImageDefinitionRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Details about the image definition that was just created.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageDefinitionResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageDefinitions/{name}": { "head": { "tags": [ "ImageDefinitions APIs" ], "summary": "Check for the existence of an image definition by name.", "description": "If the name is found to be available, this returns 404 Not Found. If the name\nis not available (i.e. an image definition with the name was found), this returns\n204 No Content.", "operationId": "ImageDefinitions_CheckImageDefinitionExist", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageDefinitions/{nameOrId}": { "delete": { "tags": [ "ImageDefinitions APIs" ], "summary": "Delete an image definition.", "operationId": "ImageDefinitions_DeleteImageDefinition", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the image definition to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "Async call", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "ImageDefinitions APIs" ], "summary": "Get details about a single image definition.", "operationId": "ImageDefinitions_GetImageDefinition", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of image definition.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageDefinitionResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "ImageDefinitions APIs" ], "summary": "Update an image definition.", "operationId": "ImageDefinitions_UpdateImageDefinition", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the image definition to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "Properties of the image definition to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateImageDefinitionRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "New image definition details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ImageDefinitionResponseModel" } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageDefinitions/{nameOrId}/ImageVersions": { "get": { "tags": [ "ImageDefinitions APIs" ], "summary": "Get all image versions associated with an image definition.", "operationId": "ImageDefinitions_GetImageDefinitionImageVersions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or Id of the image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of image versions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of image versions.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageVersionResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "ImageDefinitions APIs" ], "summary": "Create an image version.", "operationId": "ImageDefinitions_CreateImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the image version (and associated objects) will be\ncreated as a background task.\nThe task will have JobType CreateImageVersion.\nWhen the task is complete it will redirect to\nGetImageDefinitionImageVersion.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the image version to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateImageVersionRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Details about the image version that was just created.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ImageVersionResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageDefinitions/{nameOrId}/ImageVersions/{versionNumberOrId}": { "delete": { "tags": [ "ImageDefinitions APIs" ], "summary": "Delete an image version.", "operationId": "ImageDefinitions_DeleteImageDefinitionImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumberOrId", "in": "path", "required": true, "description": "Number or ID of the image version to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "purgeDBOnly", "in": "query", "description": "If this option is specified, this command will only remove the image version data from the Citrix site database.\nHowever, the disk images created in the image version still remain in the hypervisor.\n\nOptional; default is `false`.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the image version (and associated objects) will be\ndeleted as a background task.\nThe task will have JobType DeleteImageVersion.\nWhen the task is complete it will redirect to\nGetImageDefinitionImageVersion.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the image version being deleted,\n* _Number_ - Number of the image version being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "ImageDefinitions APIs" ], "summary": "Get details about a single image version.", "operationId": "ImageDefinitions_GetImageDefinitionImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumberOrId", "in": "path", "required": true, "description": "Number or ID of the image version.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details of image version.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageVersionResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "ImageDefinitions APIs" ], "summary": "Update an image version.", "operationId": "ImageDefinitions_UpdateImageDefinitionImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumberOrId", "in": "path", "required": true, "description": "Number or ID of the image version to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Properties of the image version to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateImageVersionRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "New image version details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageVersionResponseModel" } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "ImageDefinitions APIs" ], "summary": "Set properties associated with an image version.", "operationId": "ImageDefinitions_SetImageDefinitionImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumberOrId", "in": "path", "required": true, "description": "Number or ID of the image version to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the image version (and associated objects) will be\nupdated as a background task.\nThe task will have JobType SetImageVersion.\nWhen the task is complete it will redirect to\nGetImageDefinitionImageVersion.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the image version being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Details about the image version to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateImageVersionRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageDefinitions/{nameOrId}/ImageVersions/{versionNumberOrId}/$UpdateResourcePools": { "put": { "tags": [ "ImageDefinitions APIs" ], "summary": "Update resource pools associated with an image version.", "description": "Update resource pools associated with an image version.", "operationId": "ImageDefinitions_UpdateImageVersionResourcePools", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumberOrId", "in": "path", "required": true, "description": "Number or ID of image version.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the resource pools will be added into the image version as a background task.\nThe task will have JobType UpdateImageVersionResourcePools.\nWhen the task is complete it will redirect to\nGetImageDefinitionImageVersion.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the image version being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Details of the resource pools to add to the image version.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateImageVersionResourcePoolsRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageDefinitions/{nameOrId}/ImageVersions/{versionNumberOrId}/ProvisioningSchemes": { "get": { "tags": [ "ImageDefinitions APIs" ], "summary": "Get provisioning schemes associated with an image version.", "operationId": "ImageDefinitions_GetImageVersionProvisioningSchemes", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of image definition.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumberOrId", "in": "path", "required": true, "description": "Number or ID of image version.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of provisioning schemes associated with an image version.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageVersionProvisioningSchemeRefResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageDefinitionsAndImageVersions/$search": { "post": { "tags": [ "ImageDefinitions APIs" ], "summary": "Perform an advanced search for image definitions and image versions.", "description": "Perform an advanced search for image definitions and image versions.", "operationId": "ImageDefinitions_DoImageDefinitionAndImageVersionSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the search operation will be executed as a background task.\nThe task will have JobType DoImageDefinitionAndImageVersionSearch.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ImageDefinitionAndImageVersionSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of image definitions and image versions that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageDefinitionsAndImageVersionsResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageVersions/{id}": { "delete": { "tags": [ "ImageVersions APIs" ], "summary": "Delete an image version.", "operationId": "ImageVersions_DeleteImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the image version to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "purgeDBOnly", "in": "query", "description": "If this option is specified, this command will only remove the image version data from the Citrix site database.\nHowever, the disk images created in the image version still remain in the hypervisor.\n\nOptional; default is `false`.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the image version (and associated objects) will be\ndeleted as a background task.\nThe task will have JobType DeleteImageVersion.\nWhen the task is complete it will redirect to\nGetImageDefinitionImageVersion.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the image version being deleted,\n* _Number_ - Number of the image version being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "ImageVersions APIs" ], "summary": "Get details about a single image version.", "operationId": "ImageVersions_GetImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the image version.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of image version.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageVersionResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "ImageVersions APIs" ], "summary": "Update an image version.", "operationId": "ImageVersions_UpdateImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the image version to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "Properties of the image version to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateImageVersionRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "New image version details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageVersionResponseModel" } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "ImageVersions APIs" ], "summary": "Set properties associated with an image version.", "operationId": "ImageVersions_SetImageVersion", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the image version to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the image version (and associated objects) will be\nupdated as a background task.\nThe task will have JobType SetImageVersion.\nWhen the task is complete it will redirect to\nGetImageVersion.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the image version being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the image version to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateImageVersionRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageVersions/{id}/$UpdateResourcePools": { "put": { "tags": [ "ImageVersions APIs" ], "summary": "Update resource pools associated with an image version.", "description": "Update resource pools associated with an image version.", "operationId": "ImageVersions_UpdateImageVersionResourcePools", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the image version to add resource pool to.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the resource pools will be added into the image version as a background task.\nThe task will have JobType UpdateImageVersionResourcePools.\nWhen the task is complete it will redirect to\nGetImageVersion.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the image version being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the resource pools to add to the image version.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateImageVersionResourcePoolsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/ImageVersions/{id}/ProvisioningSchemes": { "get": { "tags": [ "ImageVersions APIs" ], "summary": "Get provisioning schemes associated with an image version.", "operationId": "ImageVersions_GetImageVersionProvisioningSchemes", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of image version.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of provisioning schemes associated with an image version.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageVersionProvisioningSchemeRefResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Jobs": { "get": { "tags": [ "Jobs APIs" ], "summary": "Get the list of jobs that are currently active, or have recently\ncompleted, and were initiated by the caller.", "description": "For security reasons, jobs are only visible to the caller who\ninitiated them.\n\nNote: completed jobs will be automatically removed by the system\n48 hours after completion.", "operationId": "Jobs_GetJobs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "List of jobs.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Jobs/{id}": { "delete": { "tags": [ "Jobs APIs" ], "summary": "Removes the job record.", "description": "For security reasons, jobs are only visible to the caller who\ninitiated them.\n\n\nThis may only be called if the job has completed (with or without an error\nor warning) or if the job has been cancelled. It will return an error\nif the job is still in progress.\n\n\nNote: completed jobs will be automatically removed by the system\n48 hours after completion. After this happens, this call will\nreturn `404 Not Found` when given the removed job Id.", "operationId": "Jobs_DeleteJob", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the job to remove.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Jobs APIs" ], "summary": "Get the details of a single job.", "description": "For security reasons, jobs are only visible to the caller who\ninitiated them.\n\nNote: completed jobs will be automatically removed by the system\n48 hours after completion. After this happens, this call will\nreturn `404 Not Found` when given the removed job Id.", "operationId": "Jobs_GetJob", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the job.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the job.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Jobs/{id}/$cancel": { "post": { "tags": [ "Jobs APIs" ], "summary": "Cancel a job.", "description": "For security reasons, jobs are only visible to the caller who\ninitiated them.\n\nThis may only be called if \nis `true`, OR if the job has completed (with or without an error\nor warning).\n\nNote: completed jobs will be automatically removed by the system\n48 hours after completion. After this happens, this call will\nreturn `404 Not Found` when given the removed job Id.", "operationId": "Jobs_CancelJob", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the job to remove.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Job details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Jobs/{id}/$SkipRemaining": { "post": { "tags": [ "Jobs APIs" ], "summary": "Skips any remaining / unstarted subtasks of the job.", "description": "For security reasons, jobs are only visible to the caller who\ninitiated them.\n\nOnly supported for jobs where \nis equal to . Any job that\ndoes not support this action will return a `501 Not Implemented`\nresponse code.\n\n\nIf the job has already completed successfully, this call will return\na `303 See Other` response, with a `Location` header\npointing to the affected resource(s).\n\nNote: completed jobs will be automatically removed by the system\n48 hours after completion. After this happens, this call will\nreturn `404 Not Found` when given the removed job Id.", "operationId": "Jobs_SkipRemainingSubtasks", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the job.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the job.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Jobs/{id}/Results": { "get": { "tags": [ "Jobs APIs" ], "summary": "Get the results of a job which has completed execution.", "description": "For security reasons, jobs are only visible to the caller who\ninitiated them.\n\nMost jobs do not store results, but rather, redirect the caller\nto the object(s) upon which the job was executing once complete.\nHowever, some jobs (such as long-running GET operations) have\nresults which are stored independently and are retrievable from\nthis API. Consult the documentation of the API which initiated\nthe job to determine if the results are obtained from this API\nor elsewhere.\n\n\nIf the job has completed but its results are not retrievable\nhere, the call will return a `303 See Other` response, with a\nresponse header Location directing the caller to an API where\nthe job results are obtained.\n\nNote: completed jobs will be automatically removed by the system\n48 hours after completion. After this happens, this call will\nreturn `404 Not Found` when given the removed job Id.", "operationId": "Jobs_GetJobResults", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the job.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Job results.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "String", "type": "string" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/machineCatalogActions": { "delete": { "tags": [ "Actions APIs" ], "summary": "Delete all completed machine catalog actions.", "operationId": "Actions_DeleteActions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If async to request actions. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Actions APIs" ], "summary": "Get all machine catalog actions.", "operationId": "Actions_GetActions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If async to request actions. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of actions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "ActionResponseModelCollection", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get all machine catalogs.", "description": "Get all machine catalogs in the site.", "operationId": "MachineCatalogs_GetMachineCatalogs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "adminFolder", "in": "query", "description": "Admin folder path or Id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of machine catalogs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma ','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5, "example": "Name,FullName,Id" } ], "responses": { "200": { "description": "List of machine catalogs.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCatalogResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Create a machine catalog.", "description": "Create a machine catalog.\n\nNote that if a machine catalog uses \nof , the machine catalog creation will always invoke asynchronous\njob(s) for the provisioning action. If this API is invoked asynchronously, the asynchronous job\nwill include only the machine catalog creation, and the provisioning task(s) will be associated\nwith the newly created catalog. If this API is invoked synchronously, the machine catalog\ncreation will complete synchronously but the provisioning task(s) may still be executing, and\nwill be associated with the newly created catalog.", "operationId": "MachineCatalogs_CreateMachineCatalog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "X-AccessToken", "in": "header", "description": "Access token to use when performing the operation. If specified, must be in a format matching that of the standard 'Authorization' request header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the machine catalog (and associated objects) will be\ncreated as a background task.\nThe task will have JobType CreateMachineCatalog.\nWhen the task is complete it will redirect to\nGetMachineCatalog.\nThe job's Parameters will contain properties:\n* _Name_ - Name of the machine catalog being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "sourceNameOrId", "in": "query", "description": "The machine catalog name or Id to recreate from. It is only used for catalog recreation\nscenario. Here specify name or Id of the failed catalog to recreate.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the machine catalog to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateMachineCatalogRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Details about the machine catalog that was just created.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineCatalogDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/$checkCatalogName": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Test the existence of a machine catalog by name.", "description": "Check for the existence of a machine catalog by name", "operationId": "MachineCatalogs_TestMachineCatalogExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "Name of the machine catalog.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CatalogNameCheckRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machinecatalogs/$search": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Perform an advanced search for machineCatalogs.", "description": "Perform an advanced search for machineCatalogs. Note that some combinations\nof search parameters may result in slow performance.", "operationId": "MachineCatalogs_DoMachineCatalogSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the catalogs (and associated objects) will be added as a\nbackground task.\nThe task will have JobType SearchMachineCatalogs.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of machine catalogs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CatalogSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of machine catalogs that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogSearchResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/machineCatalogs/{catalogNameOrId}/actions": { "delete": { "tags": [ "Actions APIs" ], "summary": "Delete specified catalog actions.", "operationId": "Actions_DeleteAction", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "catalogNameOrId", "in": "path", "required": true, "description": "The machine catalog name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If async calling. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Actions APIs" ], "summary": "Get machine catalog actions by specified catalog name or id and action Id.", "operationId": "Actions_GetAction", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "catalogNameOrId", "in": "path", "required": true, "description": "The machine catalog name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "actionId", "in": "query", "description": "The action Id, the guid string value. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If async calling. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "ActionResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/machineCatalogs/{catalogNameOrId}/actions/{actionId}": { "get": { "tags": [ "Actions APIs" ], "summary": "Get specified machine catalog specified action.", "operationId": "Actions_GetActionById", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "catalogNameOrId", "in": "path", "required": true, "description": "The machine catalog name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "actionId", "in": "path", "required": true, "description": "The action Id, the guid string value. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If async calling. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "Catalog creation action response\nor\nMachine creation action response\nor\nMachine removal action response\nor\nUpdate image action response\nor\nActionResponseModel\nActionCatalogCreationResponseModel\nActionMachineCreationResponseModel\nActionMachineRemovalResponseModel\nActionUpdateImageResponseModel", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResponseModel" } } }, "x-expectedSchemas": [ { "description": "Catalog creation action response", "schema": { "nullable": true, "$ref": "#/components/schemas/ActionCatalogCreationResponseModel" } }, { "description": "Machine creation action response", "schema": { "nullable": true, "$ref": "#/components/schemas/ActionMachineCreationResponseModel" } }, { "description": "Machine removal action response", "schema": { "nullable": true, "$ref": "#/components/schemas/ActionMachineRemovalResponseModel" } }, { "description": "Update image action response", "schema": { "nullable": true, "$ref": "#/components/schemas/ActionUpdateImageResponseModel" } }, { "description": "ActionResponseModel\nActionCatalogCreationResponseModel\nActionMachineCreationResponseModel\nActionMachineRemovalResponseModel\nActionUpdateImageResponseModel", "schema": { "nullable": true, "$ref": "#/components/schemas/ActionResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/machineCatalogs/{catalogNameOrId}/actions/{actionId}/$Cancel": { "post": { "tags": [ "Actions APIs" ], "summary": "Cancel the specified machine catalog and specified action.", "operationId": "Actions_CancelAction", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "catalogNameOrId", "in": "path", "required": true, "description": "The machine catalog name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "actionId", "in": "path", "required": true, "description": "The action Id, the guid string value. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If async calling. ", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{name}": { "head": { "tags": [ "MachineCatalogs APIs" ], "summary": "Check for the existence of a machine catalog by name.", "description": "Check for the existence of a machine catalog by name", "operationId": "MachineCatalogs_CheckMachineCatalogExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}": { "delete": { "tags": [ "MachineCatalogs APIs" ], "summary": "Delete a machine catalog.", "description": "Delete a machine catalog", "operationId": "MachineCatalogs_DeleteMachineCatalog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "X-AccessToken", "in": "header", "description": "Access token to use when performing the operation. If specified, must be in a format matching that of the standard 'Authorization' request header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to update.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "deleteVm", "in": "query", "description": "Specifies whether to delete virtual machines that were provisioned in the machine catalog.\nOnly relevant when ProvisioningType is\nMCS; otherwise, ignored.\n\nOptional; default is `true`.", "schema": { "title": "Boolean", "type": "boolean", "default": true, "nullable": true }, "x-position": 2 }, { "name": "deleteAccount", "in": "query", "description": "Specifies what to do with AD machine accounts that are associated with the machine\ncatalog.\n\nOptional; default is .", "schema": { "default": "None", "allOf": [ { "$ref": "#/components/schemas/MachineAccountDeleteOption" } ] }, "x-position": 3 }, { "name": "purgeDBOnly", "in": "query", "description": "Specifies whether to only delete virtual machines record that were provisioned in the machine catalog from database,\nnot access hypervisor to delete virtual machines, this is recommended only when hypervisor cannot be accessed.\n\nOptional; default is `false`.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the machine catalog (and associated objects) will be\ndeleted as a background task.\nThe task will have JobType DeleteMachineCatalog.\nWhen the task is complete it will redirect to\nGetMachineCatalogsV2Async.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the machine catalog being deleted,\n* _Name_ - Name of the machine catalog being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get details about a single machine catalog.", "description": "Get details about a single machine catalog by name or ID of machine catalog.", "operationId": "MachineCatalogs_GetMachineCatalog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "fields", "in": "query", "description": "Optional parameters, removing unspecified properties that otherwise would have been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3, "example": "Name,FullName,Id" } ], "responses": { "200": { "description": "Details of machine catalog.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineCatalogDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "MachineCatalogs APIs" ], "summary": "Update a machine catalog.", "description": "Update a machine catalog", "operationId": "MachineCatalogs_UpdateMachineCatalog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AccessToken", "in": "header", "description": "Access token to use when performing the operation. If specified, must be in a format matching that of the standard 'Authorization' request header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to update.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the machine catalog (and associated objects) will be\nupdated as a background task.\nThe task will have JobType UpdateMachineCatalog.\nWhen the task is complete it will redirect to\nGetMachineCatalog.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the machine catalog being updated,\n* _Name_ - Name of the machine catalog being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Properties of the machine catalog to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateMachineCatalogRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "New machine catalog details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineCatalogDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$export": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Exports a MCS machine catalog.", "operationId": "MachineCatalogs_Export", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The machine catalog", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "The required fields", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "The provisioning scheme and ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ExportMachineCatalogResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$exportMachineProfile": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Exports a MCS machine catalog's machine profile.", "operationId": "MachineCatalogs_ExportMachineProfile", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The name or id of machine catalog.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The content of machine profile.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ExportMachineProfileResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$importProvisionedVirtualMachines": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Import existing provisioned virtual machines.", "operationId": "MachineCatalogs_ImportProvisionedVirtualMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The machineCatalog name or Id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the machine accounts repair will be performed as a background task. ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The existing provisioned virtual machines data. ", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ImportProvisionedVirtualMachinesRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "ImportProvisionedVirtualMachineResponseModelCollection", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ImportProvisionedVirtualMachineResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$RebootMachines": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Reboot all machines in a machine catalog.", "description": "Reboot all machines in a machine catalog.\n\n\nNote that there is no job representation for the reboot operation.\nThe call returns immediately even though the machines reboot over time.\nIf you want to follow the progress of the reboot operation, check\nthe \nproperty of the machines in the machine catalog.", "operationId": "MachineCatalogs_RebootMachineCatalogMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "Reboot options.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootMachinesRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$repairMachineAccounts": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Repair all machine accounts in a machine catalog.", "description": "Repair all machine accounts in a machine catalog.", "operationId": "MachineCatalogs_RepairMachineCatalogMachineAccounts", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "repairOption", "in": "query", "required": true, "description": "The repair option of the machine accounts", "schema": { "$ref": "#/components/schemas/MachineAccountRepairOption" }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the machine accounts repair will be performed as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$RollbackProvisioningScheme": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Rollback the machine catalog's provisioning scheme.", "description": "Rollback the machine catalog's provisioning scheme.\n\n\nOnly valid when the machine catalog's ProvisioningType is MCS.\n\n\nProvides the ability to roll back the hard disk image used to provision\nvirtual machines. If the provisioning scheme has CleanOnBoot equal to\n`true`, then the next time that virtual machines are started, their\nhard disks are updated to this new image. Regardless of CleanOnBoot,\nall new virtual machines created after this call succeeds will use this\nnew hard disk image.\n\n\n*Note:* The provisioning scheme for a machine catalog cannot be\nchanged while any provisioning tasks are already executing for the\nmachine catalog. Cancel existing provisioning tasks or wait for\ntheir completion before updating the provisioning scheme.", "operationId": "MachineCatalogs_RollbackMachineCatalogProvisioningScheme", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "Due to the long-running nature of the update operation, it cannot\ncomplete synchronously, and always initiates an asynchronous job to\nrun to completion. If the `async` parameter is `true`, the only\ndifference is that instead of returning the initial job status in\nthe payload, the response is instead `202` with the `Location`\nheader pointing to the job status API. This may be desirable for\nclients that wish to unify their logic for handling asynchronous\njobs. The task will have JobType\n.\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:\n\n\n* _Id_ - ID of the machine catalog for which the provisioning scheme is being updated,\n* _Name_ - Name of the machine catalog for which the provisioning scheme is being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the image update to be performed.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RebootMachinesRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Asynchronous job status.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$test": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Run tests on a machine catalog and create a test report.", "description": "Run tests on a machine catalog and create a test report. Obtain the\nmost recent report from\nGetMachineCatalogTestReport.", "operationId": "MachineCatalogs_TestMachineCatalog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to test.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tests will run as a background task.\nThis is recommended as the tests may take some time to run,\nand if it exceeds 90 seconds the request may time out.\nThe task will have JobType TestMachineCatalog.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the machine catalog being tested,\n* _Name_ - Name of the machine catalog being tested.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "fields", "in": "query", "description": "A comma-separated list of properties to include in the response. For example, 'TestReport' to include the detailed test report.\nIf null or empty, a default set of properties will be returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Machine catalog test report.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCatalogTestResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$UpdateProvisioningScheme": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Update the machine catalog's provisioning scheme.", "description": "Update the machine catalog's provisioning scheme.\n\n\nOnly valid when the machine catalog's ProvisioningType is MCS.\n\n\nProvides the ability to update the hard disk image used to provision\nvirtual machines. If the provisioning scheme has CleanOnBoot equal to\n`true`, then the next time that virtual machines are started, their\nhard disks are updated to this new image. Regardless of CleanOnBoot,\nall new virtual machines created after this call succeeds will use this\nnew hard disk image.\n\n\nA snapshot or VM template is used rather than a VM, so that the\ncontent of the hard disk for the provisioning scheme can be easily\ndetermined.\n\n\nThe previous hard disk image path is stored into the history (see\n). The\ndata stored in the history allows for a rollback to be undertaken,\nto revert to the previous hard disk image if required.\n\n\n*Note:* The provisioning scheme for a machine catalog cannot be\nchanged while any provisioning tasks are already executing for the\nmachine catalog. Cancel existing provisioning tasks or wait for\ntheir completion before updating the provisioning scheme.", "operationId": "MachineCatalogs_UpdateMachineCatalogProvisioningScheme", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "Due to the long-running nature of the update operation, it cannot\ncomplete synchronously, and always initiates an asynchronous job to\nrun to completion. If the `async` parameter is `true`, the only\ndifference is that instead of returning the initial job status in\nthe payload, the response is instead `202` with the `Location`\nheader pointing to the job status API. This may be desirable for\nclients that wish to unify their logic for handling asynchronous\njobs. The task will have JobType\n.\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:\n\n\n* _Id_ - ID of the machine catalog for which the provisioning scheme is being updated,\n* _Name_ - Name of the machine catalog for which the provisioning scheme is being updated,\n* _MasterImageXDPath_ - Path to the new image specified for the provisioning scheme, in XenApp & XenDesktop path format.\n* _MasterImageFullPath_ - Path to the new image specified for the provisioning scheme, relative to the root of the API.\n* _MasterImageRelativePath_ - Path to the new image specified for the provisioning scheme, relative to the resource pool.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the image update to be performed.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateMachineCatalogProvisioningSchemeRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Asynchronous job status.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/$UpdatePvsScheme": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Update the machine catalog's PVS scheme.", "description": "Update the machine catalog's provisioning scheme.\n\n\nOnly valid when the machine catalog's ProvisioningType is PVS.\n\n\nProvides the ability to update the vDisk and BDM file used to provision\nvirtual machines.", "operationId": "MachineCatalogs_UpdateMachineCatalogPvsScheme", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "Due to the long-running nature of the update operation, it cannot\ncomplete synchronously, and always initiates an asynchronous job to\nrun to completion. If the `async` parameter is `true`, the only\ndifference is that instead of returning the initial job status in\nthe payload, the response is instead `202` with the `Location`\nheader pointing to the job status API. This may be desirable for\nclients that wish to unify their logic for handling asynchronous\njobs. The task will have JobType\n or .\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the image update to be performed.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateMachineCatalogPvsSchemeRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Asynchronous job status.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/Administrators": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get administrators who can administer a machine catalog.", "description": "Get administrators who can administer a machine catalog", "operationId": "MachineCatalogs_GetMachineCatalogsAdministrators", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of administrators.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AdministratorResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/CostSummary": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the machine catalog's cost summary.", "operationId": "MachineCatalogs_GetMachineCatalogCostSummary", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The name or ID of the machine catalog.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "start", "in": "query", "required": true, "description": "The start date of the cost summary, the date format is `yyyy-MM-ddT00:00:00Z`.", "schema": { "title": "DateTime", "type": "string", "format": "date-time" }, "x-position": 2 }, { "name": "end", "in": "query", "required": true, "description": "The end date of the cost summary, the date format is `yyyy-MM-ddT00:00:00Z`.", "schema": { "title": "DateTime", "type": "string", "format": "date-time" }, "x-position": 3 }, { "name": "summaryType", "in": "query", "description": "The summary type of the cost, Currently only `VM` and `Disk` are supported.", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/SummaryType" } ] }, "x-position": 4 }, { "name": "async", "in": "query", "description": "if the value is `true`, the machine catalog's cost summary will be calculated asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "The machine catalog's cost summary.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ResourceCostResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/DailyCost": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the machine catalog's daily cost.", "operationId": "MachineCatalogs_GetMachineCatalogDailyCost", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The name or ID of the machine catalog.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "start", "in": "query", "required": true, "description": "The start date of the daily cost, the date format is `yyyy-MM-ddT00:00:00Z`.", "schema": { "title": "DateTime", "type": "string", "format": "date-time" }, "x-position": 2 }, { "name": "end", "in": "query", "required": true, "description": "The end date of the daily cost, the date format is `yyyy-MM-ddT00:00:00Z`.", "schema": { "title": "DateTime", "type": "string", "format": "date-time" }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If the value is `true`, the machine catalog's daily cost will be calculated asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "The machine catalog's daily cost.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DailyCostResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/DeliveryGroupAssociations": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get delivery group associations of a machine catalog.", "description": "Get delivery group associations by name or Id of a remote pc machine catalog.", "operationId": "MachineCatalogs_GetMachineCatalogDeliveryGroupAssociations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of delivery group associations returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "The delivery group associations of the given machine catalog identifier", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupAssociationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/Enrollments": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the list of enrollments in the machine catalog.", "operationId": "MachineCatalogs_GetMachineCatalogEnrollments", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of enrollments.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollmentResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/LastMasterImage": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the last master VM images used by the machine catalog.", "description": "Get the last master VM images used by the machine catalog", "operationId": "MachineCatalogs_GetMachineCatalogLastMasterImage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Last image used by the machine catalog to provision VMs.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VMImageResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/MachineAccounts": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get all machine accounts associated with a machine catalog.", "description": "Get all machine accounts associated with a machine catalog. This returns\nall machine accounts for the machine catalog regardless of whether they are\nin-use, available, locked, etc.\n\n\nThis is only relevant for machine catalogs where ProvisioningType is MCS.", "operationId": "MachineCatalogs_GetMachineCatalogMachineAccounts", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to get machine accounts for.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of machine accounts returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the machine accounts will be queried as a background task.\nThe task will have JobType GetMachineCatalogMachineAccounts.\nWhen the task is complete it will redirect to GetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 }, { "name": "accountState", "in": "query", "description": "The state of accounts for query.", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeMachineAccountState" } ] }, "x-position": 5 } ], "responses": { "200": { "description": "List of machine accounts.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisioningSchemeMachineAccountResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Add a machine account to the machine catalog.", "description": "Add a machine account to the machine catalog. This is only relevant for machine catalogs where ProvisioningType is MCS.", "operationId": "MachineCatalogs_AddMachineCatalogMachineAccount", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to add the machine account to.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "machine", "description": "Machine account to add to the machine catalog. The machine must not be a member of any other machine catalog.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineAccountRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Machine account that was added.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeMachineAccountResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/MachineAccounts/{machine}": { "delete": { "tags": [ "MachineCatalogs APIs" ], "summary": "Remove a machine account from the machine catalog.", "description": "Remove a machine account from the machine catalog. This is only relevant for machine catalogs where ProvisioningType is MCS.", "operationId": "MachineCatalogs_RemoveMachineCatalogMachineAccount", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to remove the machine account from.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "machine", "in": "path", "required": true, "description": "Machine account to remove. May be specified by SamName, UPN, or SID.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "deleteAccount", "in": "query", "description": "Specifies what to do with the machine account in AD. Optional; default is None.", "schema": { "default": "None", "allOf": [ { "$ref": "#/components/schemas/MachineAccountDeleteOption" } ] }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "MachineCatalogs APIs" ], "summary": "Update a machine account within the machine catalog.", "description": "Update a machine account within the machine catalog. This is typically used to reset or\nupdate the machine password so that the site is able to apply the machine account to a\nprovisioned VM.\n\n\nThis is only relevant for machine catalogs where ProvisioningType is MCS.", "operationId": "MachineCatalogs_UpdateMachineCatalogMachineAccount", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog containing the machine account.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "machine", "in": "path", "required": true, "description": "Machine account to update. May be specified by SamName, UPN, or SID.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "details", "description": "New details for the machine account record.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateMachineAccountRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Machine account details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeMachineAccountResponseModel" } } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/Machines": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "GET the machines of a catalog", "operationId": "MachineCatalogs_GetMachineCatalogMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of machines returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 }, { "name": "fields", "in": "query", "description": "Optional parameters, only the specified properties in the fields are required.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5, "example": "Uid,AgentVersion,AllocationType" } ], "responses": { "200": { "description": "The machines of the given machine catalog identifier", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Add machine to the machine catalog.", "description": "Add a machine to the machine catalog. This is the first step in making the\nmachine available to run users' desktops and applications. The machine may\nbe physical or virtual. The type of machine (physical or virtual) must\nmatch the machine catalog configuration.\n\n\nNote that due to\nthe long-running nature of the adding operation, it cannot\ncomplete synchronously, would always initiate an asynchronous job to\nrun to completion.\n\n\nThe machine must support the expected capabilities of the machine catalog:\nthe and\n. The session\nsupport of the machine is determined by the type of Citrix VDA software\ninstalled (server or workstation) and the functional level depends on the\nversion of the Citrix VDA software installed. The API will complete\nsuccessfully if these are not correct but the machine will be unable to register.\n\n\nNote: to add multiple machines in a single call, use the\n API.", "operationId": "MachineCatalogs_AddMachineCatalogMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "X-AccessToken", "in": "header", "description": "Access token to use when performing the operation. If specified, must be in a format matching that of the standard 'Authorization' request header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to add machine to.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the machine will be added into the machine catalog as a background task.\nThe task will have JobType AddMachineCatalogMachine.\nWhen the task is complete it will redirect to\nGetMachineCatalog.\nThe job's Parameters will contain properties:\n* _NameOrId_ - Name or ID of the machine being added.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "machine", "description": "Details of the machine to add to the machine catalog.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/AddMachineToMachineCatalogDetailRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Asynchronous job status.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/Machines/{machine}": { "delete": { "tags": [ "MachineCatalogs APIs" ], "summary": "Remove a machine from the machine catalog.", "description": "Remove a machine from the machine catalog. Removing the machine from the machine\ncatalog removes it from the site.\n\n\nA machine cannot be removed from the machine catalog if it is a member of a delivery group.\n\n\nNote: to remove multiple machines in a single call, use the\n API.", "operationId": "MachineCatalogs_RemoveMachineCatalogMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog to remove the machine from.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "machine", "in": "path", "required": true, "description": "Machine to remove from the catalog. May be specified by name, ID, or SID. If param is Name, currently it should get rid of '\\\\' and replace it using '|'.\n For instance, if a MachineName is \"DomainA\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/MasterImageHistory": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the history of master VM images used by the machine catalog.", "description": "Get the history of master VM images used by the machine catalog", "operationId": "MachineCatalogs_GetMachineCatalogMasterImageHistory", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of images used by the machine catalog to provision VMs.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/VMImageResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/RemotePCEnrollmentScopes/$checkScopeName": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Check for the existence of a RemotePC enrollment scope by name in the request body.\nUse HttpPost and take name in body as this name may be very long, and cause url too long exception.", "description": "Check for the existence of a RemotePC enrollment scope by name. Note that\nRemotePC enrollment scope names must be unique within the site, so the\n`nameOrId` parameter does not affect whether the RemotePC enrollment scope\nname is found.\nIf the name is found to be available, this returns 404 Not Found.\nIf a RemotePC enrollment scope by that name exists and is associated with the\nspecified machine catalog, this returns 204 No Content. If a RemotePC\nenrollment scope by that name exists and is associated with a different\nmachine catalog, this returns 303 See Other, and the `Location`\nresponse header refers to location of the machine catalog which is associated\nby the RemotePC enrollment scope.", "operationId": "MachineCatalogs_TestRemotePCEnrollmentScopeExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "Request model that contains distinguished name of an OU containing machines allowed to enroll as remote PCs.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RemotePCEnrollmentScopeCheckModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/RemotePCEnrollmentScopes/{name}": { "head": { "tags": [ "MachineCatalogs APIs" ], "summary": "Check for the existence of a RemotePC enrollment scope by name.", "description": "Check for the existence of a RemotePC enrollment scope by name. Note that\nRemotePC enrollment scope names must be unique within the site, so the\n`nameOrId` parameter does not affect whether the RemotePC enrollment scope\nname is found.\nIf the name is found to be available, this returns 404 Not Found.\nIf a RemotePC enrollment scope by that name exists and is associated with the\nspecified machine catalog, this returns 204 No Content. If a RemotePC\nenrollment scope by that name exists and is associated with a different\nmachine catalog, this returns 303 See Other, and the `Location`\nresponse header refers to location of the machine catalog which is associated\nby the RemotePC enrollment scope.", "operationId": "MachineCatalogs_CheckRemotePCEnrollmentScopeExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Distinguished name of an OU containing machines allowed to enroll as remote PCs.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/StartMenuApplications": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the start menu applications from a machine in the machine catalog.", "description": "Get the start menu applications from a machine in the machine catalog\n\nNote that this API may require a machine within a catalog to be\nbooted, if no machines are currently available. Therefore, the API\nmay take quite some time to complete. Consider using the `async=true`\nparameter to mitigate this.", "operationId": "MachineCatalogs_GetMachineCatalogStartMenuApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "machines", "in": "query", "style": "form", "explode": true, "description": "The machines to get start menu applications", "schema": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the start menu applications will be queried as a background task.\nThis is recommended as this operation may cause a power\naction, turning on a machine in order to gather the data.\nThis may take some time to run,\nand if it exceeds 90 seconds the request may time out.\nThe task will have JobType GetStartMenuApplications.\nWhen the task is complete it will redirect to\n\"JobsControllerTP.GetJobResults(string)\".\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the machine catalog from which start menu applications are being obtained,\n* _Name_ - Name of the machine catalog from which start menu applications are being obtained.\n* _MachineId_ - ID of the machine selected, from which the start menu applications are being obtained; will be present in Parameters only after a machine is selected.\n* _MachineName_ - Name of the machine selected, from which the start menu applications are being obtained; will be present in Parameters only after a machine is selected.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of start menu applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartMenuApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/Tags": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get tags associated with a machine catalog.", "description": "Get tags associated with a machine catalog. This includes tags which are\ndirectly associated with the machine catalog, as well as tags associated with\nmachines that are associated with the machine catalog.\nTo find only tags directly associated with the machine catalog,\nfilter the results to those with\nNumMachineCatalogs equal to `1`.", "operationId": "MachineCatalogs_GetMachineCatalogTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "Optional parameters, removing unspecified properties that otherwise would have been sent by the server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Name,Id,Description" } ], "responses": { "200": { "description": "List of tags.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "MachineCatalogs APIs" ], "summary": "Set tags associated with a machine catalog.", "operationId": "MachineCatalogs_SetMachineCatalogTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the tags to set on the machine catalog.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/Tags/{tagNameOrId}": { "delete": { "tags": [ "MachineCatalogs APIs" ], "summary": "Remove a tag from a machine catalog.", "description": "Remove a tag from a machine catalog. Does not delete the tag,\nonly its association to the machine catalog.", "operationId": "MachineCatalogs_RemoveMachineCatalogTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Add a tag to a machine catalog.", "operationId": "MachineCatalogs_AddMachineCatalogTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag to add.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "List of tags associated with the machine catalog.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/TestReport": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the most recent test report of a machine catalog.", "description": "Get the test report from the last run of\nTestMachineCatalog.", "operationId": "MachineCatalogs_GetMachineCatalogTestReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Last test report. If no tests have been run,\nreturns a 404 Not Found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/UpgradeSchedule": { "delete": { "tags": [ "MachineCatalogs APIs" ], "summary": "Remove a pending VDA upgrade schedule for a machine catalog.", "description": "A VDA upgrade schedule can only be cancelled for a machine catalog\nwhen the upgrade status is waiting to start. If the current upgrade is\nin another status, the operation fails with HTTP response status 404.", "operationId": "MachineCatalogs_RemoveMachineCatalogUpgradeSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "force", "in": "query", "description": "If `true`, VDA upgrade schedules existing with all machines within the\ncatalog will be removed except those upgrade status in progressing.\nIf `false`, only to perform removing when catalog level schedule not started.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the VDA upgrade schedule will be removed as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "MachineCatalogs APIs" ], "summary": "Reschedule a pending VDA upgrade schedule for a machine catalog.", "operationId": "MachineCatalogs_UpdateMachineCatalogUpgradeSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the VDA upgrade schedule will be updated as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the updated VDA upgrade schedule.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateUpgradeScheduleRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "409": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Setup a new VDA upgrade schedule for a machine catalog.", "description": "A new VDA upgrade schedule can only be created for a machine catalog\nwhen the upgrade status for the catalog is UpgradeSuccessful, UpgradeFailed or UpgradeCancelled.\nIf the status is ongoing or waiting to start, the operation fails.", "operationId": "MachineCatalogs_CreateMachineCatalogUpgradeSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the VDA upgrade schedule will be created as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the VDA upgrade schedule to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateUpgradeScheduleRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/VDAComponentsAndFeatures": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the components and features of VDAs associated with a machine catalog.", "operationId": "MachineCatalogs_GetMachineCatalogVDAComponentsAndFeatures", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "upgradeVersion", "in": "query", "description": "The version of the VDA to upgrade to.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Components and features of VDAs associated with a machine catalog.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCatalogVusComponentResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/VDAComponentsAndFeatures/$validate": { "post": { "tags": [ "MachineCatalogs APIs" ], "summary": "Validate the VDA component selection at catalog level that can be Included/Excluded and features that need enable\nduring an VDA upgrade using VDA Upgrade Service.", "operationId": "MachineCatalogs_ValidateMachineCatalogVDAComponentsAndFeaturesSelection", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog. If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If async execute.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "More details attached to this validation.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/VDAComponentsSelectionValidationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The validation result.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/VDAComponentsSelectionValidationResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogs/{nameOrId}/VDAUpgradeVersions": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "Get the available VDA upgrade versions associated with a machine catalog.", "operationId": "MachineCatalogs_GetMachineCatalogVDAUpgradeVersions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine catalog.\n If the catalog is present in a catalog folder,\n specify the name in this format: {catalog folder path plus catalog name}.\n For example, FolderName1|FolderName2|CatalogName.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The list of available VDA upgrade versions associated with a machine catalog.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "IList`1", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachineCatalogsV2": { "get": { "tags": [ "MachineCatalogs APIs" ], "summary": "The V2 version of get all machine catalogs.", "description": "Get all machine catalogs in the site with default response fields if no fields parameters specified.", "operationId": "MachineCatalogs_GetMachineCatalogsV2", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "adminFolder", "in": "query", "description": "Admin folder path or Id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of machine catalogs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma ','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5, "example": "Name,FullName,Id" } ], "responses": { "200": { "description": "List of machine catalogs.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCatalogResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines": { "get": { "tags": [ "Machines APIs" ], "summary": "Get all machines in the site.", "description": "Get all the machines in the site. Note that the response\nmay not contain the entire list of machines; if this happens the\nresponse will have a ContinuationToken\nwhich, if passed, will resume retrieving results from the original\nquery.", "operationId": "Machines_GetMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "sessionSupport", "in": "query", "description": "Optionally limit the results to machines that are either single or multi-session capable.\nIf not specified, all types of machines are returned.", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/SessionSupport" } ] }, "x-position": 1 }, { "name": "configured", "in": "query", "description": "Optionally limit the results to machines that are either configured or not.\nIf not specified, only configured machines are returned.", "schema": { "title": "Boolean", "type": "boolean", "default": true, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of machines returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the get machines will be executed as a background task.\nThe task will have JobType GetMachines.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6, "example": "Uid,AgentVersion,AllocationType" } ], "responses": { "200": { "description": "List of machines.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/$group": { "post": { "tags": [ "Machines APIs" ], "summary": "Groups and counts machines based advanced search filter.", "description": "Groups and counts machines based on the advanced search filter.", "operationId": "Machines_GroupMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the search machines will be executed as a background task.\nThe task will have JobType GroupMachine.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "groupRequest", "description": "Specifies the advanced search parameters and grouping property.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineGroupRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Dictionary of property value and the counts of machines that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "IDictionary`2", "type": "object", "additionalProperties": { "title": "Int32", "type": "integer", "format": "int32" } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/$search": { "post": { "tags": [ "Machines APIs" ], "summary": "Perform an advanced search for machines.", "description": "Perform an advanced search for machines. Note that some combinations\nof search parameters may result in slow performance and only configured machines will be returned.\n\nThe 'SessionSupport' \nmust be included in search filters.", "operationId": "Machines_DoMachineSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of machines returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the search machines will be executed as a background task.\nThe task will have JobType DoMachineSearch.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 }, { "name": "skip", "in": "query", "description": "The number of machines to skip.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 6 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineAndSessionSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of machines that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{name}": { "head": { "tags": [ "Machines APIs" ], "summary": "Check for the existence of a machine by name.", "description": "Check for the existence of a machine by name", "operationId": "Machines_CheckMachineExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'.\n For instance, if a MachineName is \"DomainA\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}": { "delete": { "tags": [ "Machines APIs" ], "summary": "Delete a machine from the site.", "operationId": "Machines_RemoveMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-AdminCredential", "in": "header", "description": "Admin credential to use when performing the operation. If not specified, the operation will be performed using the account under which the identity service is running If specified, must be in a format matching that of the standard 'Authorization' request header; the username and password separated by a colon, UTF8-encoded, then base64-encoded, then the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to remove. May be specified by SamName, UPN, or SID. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "deleteVm", "in": "query", "description": "Specifies whether to delete the virtual machines, or just the machine record\nin the site database.\nOnly relevant when ProvisioningType equals MCS.\nOptional; default is `true`.", "schema": { "title": "Boolean", "type": "boolean", "default": true }, "x-position": 2 }, { "name": "purgeDBOnly", "in": "query", "description": "Specifies whether to only delete virtual machines record that were provisioned in the machine catalog from database,\nnot access hypervisor to delete virtual machines, this is recommended only when hypervisor cannot be accessed.\n\nOptional; default is `false`.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 }, { "name": "deleteAccount", "in": "query", "description": "Specifies what to do with the machine account in AD. Optional; default is\nLeave.\nOnly relevant when `deleteVm` is `true`; otherwise, ignored.", "schema": { "default": "Leave", "allOf": [ { "$ref": "#/components/schemas/MachineAccountDeleteOption" } ] }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the machine will be deleted as a background task.\nThe task will have JobType DeleteMachine.\nWhen the task is complete it will redirect to\nThe job's Parameters will contain properties:\n* _Id_ - ID of the machine being deleted,\n* _Name_ - Name of the machine being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Machines APIs" ], "summary": "Get details of a single machine which belongs to this site, or have registered but are not yet configured in this site", "description": "Get details of a single machine.", "operationId": "Machines_GetMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "The requested fields.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Uid,AgentVersion,AllocationType" } ], "responses": { "200": { "description": "Details of the machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Machines APIs" ], "summary": "Update a machine.", "description": "Update a machine. Typically used to change the assignment of a\nstatically-assigned machine.", "operationId": "Machines_UpdateMachineCatalogMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to update. May be specified by name, ID, or SID. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tag will be created as a background task.\nThe task will have JobType UpdateMachineCatalogMachine.\nWhen the task is complete it will redirect to\nGetMachine.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the machine being updated,\n* _Name_ - Name of the machine being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "update", "description": "Details of the machine to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateMachineRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/$disconnect": { "post": { "tags": [ "Machines APIs" ], "summary": "Disconnect all sessions on a machine.", "description": "Disconnect all sessions on a machine.", "operationId": "Machines_DisconnectSessions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to disconnect sessions from. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic machine model.", "schema": { "title": "Boolean", "type": "boolean", "default": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the session will be disconnected as a background task.\nThe task will have JobType DisconnectSessions.\nWhen the task is complete it will redirect to\nGetMachine.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the machine on which sessions are being disconnected.\n* _Name_ - Name of the machine on which sessions are being disconnected.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Detail of the machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/$logoff": { "post": { "tags": [ "Machines APIs" ], "summary": "Logoff all sessions on a machine.", "description": "Logoff all sessions on a machine", "operationId": "Machines_LogoffMachineSessions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to log sessions off from. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic machine model.", "schema": { "title": "Boolean", "type": "boolean", "default": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the sessions will be logged off as a background task.\nThe task will have JobType .\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:\n\n\n* _Id_ - ID of the machine which sessions are being logged off from,\n* _Name_ - Name of the machine which sessions are being logged off from.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Machine detail.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/$reboot": { "post": { "tags": [ "Machines APIs" ], "summary": "Reboot a machine.", "description": "Reboot a machine. The machine must be capable of power management.", "operationId": "Machines_RebootMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to reboot. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "force", "in": "query", "description": "If `true`, the machine will be forced to reboot without waiting for user\nactivity to stop. This may cause loss of user data if work is not saved.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic machine model.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the machine will be rebooted as a background task.\nThis is recommended as this operation may take some time to run, and if it\nexceeds 90 seconds the request may time out.\nThe task will have JobType RebootMachines.\nWhen the task is complete it will redirect to\nGetMachine.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the machine being rebooted,\n* _Name_ - Name of the machine being rebooted.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "Machine detail.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/$resume": { "post": { "tags": [ "Machines APIs" ], "summary": "Resume a machine.", "description": "Resume a machine after it has been suspended. The machine must be capable of\npower management.", "operationId": "Machines_ResumeMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to resume. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic machine model.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the machine will be resumed as a background task.\nThis is recommended as this operation may take some time to run, and if it\nexceeds 90 seconds the request may time out.\nThe task will have JobType ResumeMachines.\nWhen the task is complete it will redirect to\nGetMachine.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the machine being resumed,\n* _Name_ - Name of the machine being resumed.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Machine detail.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/$shutdown": { "post": { "tags": [ "Machines APIs" ], "summary": "Shut down a machine.", "description": "Shut down (power-off) a machine. The machine must be capable of power\nmanagement.", "operationId": "Machines_ShutdownMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to shut down. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "force", "in": "query", "description": "If `true`, the machine will be forced to shut down without waiting for user\nactivity to stop. This may cause loss of user data if work is not saved.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic machine model.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the machine will be shut down as a background task.\nThis is recommended as this operation may take some time to run, and if it\nexceeds 90 seconds the request may time out.\nThe task will have JobType ShutDownMachines.\nWhen the task is complete it will redirect to\nGetMachine.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the machine being shut down,\n* _Name_ - Name of the machine being shut down.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 }, { "name": "delay", "in": "query", "description": "Shutdown a machine after the specified number of seconds delay,\nIf `null`, the machine will be shut down without delay.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "Machine detail.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/$start": { "post": { "tags": [ "Machines APIs" ], "summary": "Start a machine.", "description": "Start (power-on) a machine. The machine must be capable of power management.", "operationId": "Machines_StartMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to start. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic machine model.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the machine will be started as a background task.\nThis is recommended as this operation may take some time to run, and if it\nexceeds 90 seconds the request may time out.\nThe task will have JobType StartMachines.\nWhen the task is complete it will redirect to\nGetMachine.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the machine being started,\n* _Name_ - Name of the machine being started.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Machine detail.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/$suspend": { "post": { "tags": [ "Machines APIs" ], "summary": "Suspend a machine.", "description": "Suspend a machine. The machine must be capable of power management.", "operationId": "Machines_SuspendMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to suspend. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "detailResponseRequired", "in": "query", "description": "Identify if the API need to return detail info in response model.\n Set to false will improve performance with return basic machine model.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the machine will be suspended as a background task.\nThis is recommended as this operation may take some time to run, and if it\nexceeds 90 seconds the request may time out.\nThe task will have JobType SuspendMachines.\nWhen the task is complete it will redirect to\nGetMachine.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the machine being suspended,\n* _Name_ - Name of the machine being suspended.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "delay", "in": "query", "description": "Suspend a machine after the specified number of seconds delay,\nIf `null`, the machine will be suspended without delay.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "Machine detail.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/$test": { "post": { "tags": [ "Machines APIs" ], "summary": "Test a machine.", "operationId": "Machines_TestMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine to test. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "A comma-separated list of properties to include in the response. For example, 'TestReport' to include the detailed test report.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the test will be executed as a background task.\nThe task will have JobType TestMachine.\nWhen the task is complete it will redirect to\nGetJobResults.\nThis is especially useful when includeReport is true, as waiting for the report may take some time.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Test result or job information.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineTestResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/Administrators": { "get": { "tags": [ "Machines APIs" ], "summary": "Get administrators who can administer a machine", "description": "Get administrators who can administer a machine.", "operationId": "Machines_GetMachinesAdministrators", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "SamName, UPN, or SID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of administrators.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministratorResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/Applications": { "get": { "tags": [ "Machines APIs" ], "summary": "Get the list of applications on a machine.", "description": "Get the list of applications published or in use on a machine.\nAt least one of Published\nor InUse\nwill be `true` for each application returned.", "operationId": "Machines_GetMachineApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineApplicationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/DeliveryGroup": { "get": { "tags": [ "Machines APIs" ], "summary": "Get the delivery group for a machine.", "description": "Get the details of the delivery group in which a machine resides.", "operationId": "Machines_GetMachineDeliveryGroup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the delivery group. If the machine is not a member of\na delivery group, the response will be `204 No Content`.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/Desktop": { "get": { "tags": [ "Machines APIs" ], "summary": "Get the desktop associated with the machine, if any.", "description": "Get the details of the desktop associated with the machine, if any.", "operationId": "Machines_GetMachineDesktop", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the desktop. If the machine is not associated with a\ndesktop, the response will be `204 No Content`.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesktopResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/FileTypes/$import": { "post": { "tags": [ "Machines APIs" ], "summary": "Import file type associations from the machine.", "operationId": "Machines_ImportFileTypes", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the file types will be imported as a background task.\nThe task will have JobType ImportFTA.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n* _MachineId_ - ID of the machine\n* _MachineName_ - Name of the machine", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of file type associations imported from the machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/FtaResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/MachineCatalog": { "get": { "tags": [ "Machines APIs" ], "summary": "Get the machine catalog for a machine.", "description": "Get the details of the machine catalog in which a machine resides.", "operationId": "Machines_GetMachineMachineCatalog", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the machine catalog.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineCatalogDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/PowerActionSchedules": { "delete": { "tags": [ "Machines APIs" ], "summary": "Remove pending power action schedules for a machine.", "operationId": "Machines_RemovePowerActionSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the power action schedule will be removed as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Machines APIs" ], "summary": "Get the power action schedules associated with a machine.", "operationId": "Machines_GetMachinePowerActionSchedules", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of power action schedules.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/PowerActionScheduleResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/Sessions": { "get": { "tags": [ "Machines APIs" ], "summary": "Get the list of sessions running on a machine.", "description": "Get the list of sessions running on a machine", "operationId": "Machines_GetMachineSessions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "The requested session fields.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Id,Uid,ApplicationsInUse" } ], "responses": { "200": { "description": "List of sessions.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/StartMenuShortcutIcon": { "get": { "tags": [ "Machines APIs" ], "summary": "Get a start menu shortcut icon from the machine.", "description": "Get a start menu shortcut icon from the machine. The machine must be powered-on\nand registered in order for the call to succeed.\n\n\nThis icon is usually used to help create a published application.", "operationId": "Machines_GetMachineStartMenuShortcutIcon", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to get the shortcut icon from. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "shortcutPath", "in": "query", "description": "Path to the start menu shortcut.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "iconFormat", "in": "query", "description": "Icon format. Must be:\n`{mime-type};{width}x{height}x{colordepth}`\n\n\nwhere:\n\n\n* _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n* _width_ and _height_ are specified in pixels.\n* _colordepth_ (optional) is either `8` or `24`.\n\n\nOptional. If not specified, only the raw icon data will be returned.\nNote that this is typically in ICO format, which many clients cannot\ndisplay properly.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the start menu shortcut icon will be queried as a background task.\nThe task will have JobType GetMachineStartMenuShortcutIcon.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the machine from which start menu icon are being obtained,\n* _Name_ - Name of the machine from which start menu icon are being obtained.\n* _ShortcutPath_ - Path to the start menu shortcut.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "Icon data in the requested format.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/StartMenuShortcuts": { "get": { "tags": [ "Machines APIs" ], "summary": "Get start menu shortcuts from the machine.", "description": "Get start menu shortcuts from the machine. The machine must be powered-on\nand registered in order for the call to succeed.\n\n\nThe shortcuts obtained are from the 'All users' start menu; user-specific shortcuts are not found.\n\n\nNote that this call does not retrieve the shortcut icon; use\n\nto get the icon.", "operationId": "Machines_GetMachineStartMenuShortcuts", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Machine to get the shortcuts from. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of shortcuts.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StartMenuApplicationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/Tags": { "get": { "tags": [ "Machines APIs" ], "summary": "Get tags associated with a machine.", "description": "Get tags associated with a machine. This includes tags which are\ndirectly associated with the machine, as well as tags associated\nwith delivery groups, application groups, or applications that are\nassociated with the machine. To find only tags directly associated\nwith the machine, filter the results to those with\nNumMachines equal to `1`.", "operationId": "Machines_GetMachineTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned,\nthe requested fields are separated by comma','. return all if not specified.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Name,Id,Description" } ], "responses": { "200": { "description": "List of tags.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "Machines APIs" ], "summary": "Set tags associated with a machine.", "operationId": "Machines_SetMachineTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned,\nthe requested fields are separated by comma','.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "description": "Details of the tags to set on the machine.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/Tags/{tagNameOrId}": { "delete": { "tags": [ "Machines APIs" ], "summary": "Remove a tag from a machine.", "operationId": "Machines_RemoveMachineTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Machines APIs" ], "summary": "Add a tag to a machine.", "operationId": "Machines_AddMachineTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "tagNameOrId", "in": "path", "required": true, "description": "Name or ID of the tag to add.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "List of tags associated with the machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/TestReports/{reportId}": { "get": { "tags": [ "Machines APIs" ], "summary": "Get Cloud Health Check Report on a VDA machine.", "operationId": "Machines_GetTestMachineReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine to test. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "reportId", "in": "path", "required": true, "description": "ID of the Cloud Health Check Report.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Machine test report.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineTestResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/UpgradeSchedule": { "delete": { "tags": [ "Machines APIs" ], "summary": "Remove a pending VDA upgrade schedule for a machine.", "operationId": "Machines_RemoveMachineUpgradeSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "force", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the VDA upgrade schedule will be removed as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Machines APIs" ], "summary": "Reschedule a pending VDA upgrade schedule for a machine.", "operationId": "Machines_UpdateMachineUpgradeSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the VDA upgrade schedule will be updated as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the updated VDA upgrade schedule.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateUpgradeScheduleRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Machines APIs" ], "summary": "Setup a new VDA upgrade schedule for a machine.", "operationId": "Machines_CreateMachineUpgradeSchedule", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the VDA upgrade schedule will be created as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the VDA upgrade schedule to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateUpgradeScheduleRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/UpgradeVersions": { "get": { "tags": [ "Machines APIs" ], "summary": "Get available upgrade versions for a machine.", "operationId": "Machines_GetMachineUpgradeVersions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of available upgrade versions for the machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "IList`1", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/VDAComponentsAndFeatures": { "get": { "tags": [ "Machines APIs" ], "summary": "Get the components and features of VDAs associated with a machine.", "operationId": "Machines_GetVDAComponentsAndFeatures", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "upgradeVersion", "in": "query", "description": "The version of the VDA to upgrade to.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Components and features of VDAs associated with a machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VDAComponentsAndFeaturesResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Machines/{nameOrId}/VDAComponentsAndFeatures/$validate": { "post": { "tags": [ "Machines APIs" ], "summary": "Validate the VDA component selection at machine level that can be Included/Excluded and features that need enable\nduring an VDA upgrade using VDA Upgrade Service.", "operationId": "Machines_ValidateVDAComponentsAndFeaturesSelection", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the machine. If param is Name, currently it should get rid of '\\\\' and replace it using '|'. For instance, if a MachineName is \"DomainA\\\\NameB\", the param will be \"DomainA|NameB\".", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If async execute.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "More details attached to this validation.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/VDAComponentsSelectionValidationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "The validation result.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/VDAComponentsSelectionValidationResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/MachinesV2": { "get": { "tags": [ "Machines APIs" ], "summary": "The V2 version of get all machines in the site.", "description": "Get all the machines in the site with default response fields if no fields parameters specified. Note that the response\nmay not contain the entire list of machines; if this happens the\nresponse will have a ContinuationToken\nwhich, if passed, will resume retrieving results from the original\nquery.", "operationId": "Machines_GetMachinesV2", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "sessionSupport", "in": "query", "description": "Optionally limit the results to machines that are either single or multi-session capable.\nIf not specified, all types of machines are returned.", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/SessionSupport" } ] }, "x-position": 1 }, { "name": "configured", "in": "query", "description": "Optionally limit the results to machines that are either configured or not.\nIf not specified, only configured machines are returned.", "schema": { "title": "Boolean", "type": "boolean", "default": true, "nullable": true }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of machines returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the get machines will be executed as a background task.\nThe task will have JobType GetMachines.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 6, "example": "Uid,AgentVersion,AllocationType" } ], "responses": { "200": { "description": "List of machines.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/me": { "get": { "tags": [ "Me APIs" ], "summary": "Get my details.", "description": "Gets details about the currently logged-in admin, including the\nlist of customers and sites that the admin has access to.", "operationId": "Me_GetMe", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "Details about the currently logged-in admin.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MeResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/me/Preferences": { "get": { "tags": [ "Me APIs" ], "summary": "Get my preferences.", "description": "Get my preferences.\nPreferences are free-form name/value pairs that are typically used to\nkeep track of how the user has configured the UI, so that the configuration\nis retained across sessions.", "operationId": "Me_GetMyPreferences", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "namePrefix", "in": "query", "description": "Optional name prefix to filter results. If not specified, all preferences are returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of user preferences.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/NameValueStringPairModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "Me APIs" ], "summary": "Set a preference value.", "description": "Set a preference value.\nPreferences are free-form name/value pairs that are typically used to\nkeep track of how the user has configured the UI, so that the configuration\nis retained across sessions.\nNote: if a preference with the given name already exists, it will be\noverridden.", "operationId": "Me_SetMyPreference", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "preference", "description": "Preference to set.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SetPreferenceModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/me/Preferences/{name}": { "delete": { "tags": [ "Me APIs" ], "summary": "Delete one of admin preferences by name.", "description": "Delete one of my preferences by name.", "operationId": "Me_DeleteMyPreference", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Preference name.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Me APIs" ], "summary": "Get one of my preferences by name.", "description": "Get one of my preferences by name.\nPreferences are free-form name/value pairs that are typically used to\nkeep track of how the user has configured the UI, so that the configuration\nis retained across sessions.", "operationId": "Me_GetMyPreference", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Preference name.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "User preferences", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Notifications": { "get": { "tags": [ "Jobs APIs" ], "summary": "Get notifications.", "description": "For security reasons, notification items are only visible to the caller who initiated them.", "operationId": "Jobs_GetNotifications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "List of notification.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/JobResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Notifications/$dismiss": { "post": { "tags": [ "Jobs APIs" ], "summary": "Dismiss all the notifications for one caller.", "description": "For security reasons, jobs are only dismissable to the caller who\ninitiated them.", "operationId": "Jobs_DismissAllNotification", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Notifications/{id}/$dismiss": { "post": { "tags": [ "Jobs APIs" ], "summary": "Dismiss the notification for one specific job.", "description": "For security reasons, jobs are only dismissable to the caller who\ninitiated them.", "operationId": "Jobs_DismissNotification", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the job.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines": { "get": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Gets the VMs created using Machine Creation Services.", "operationId": "ProvisionedVirtualMachine_GetProvisionedVirtualMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionedVirtualMachineDetailsResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/$scheduleResetOSDisk": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "operationId": "ProvisionedVirtualMachine_ScheduleProvisionedVirtualMachinesResetOSDisk", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ScheduleProvisionedVMTaskDetailResetOSDiskRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MaintenanceCycleTaskDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/$scheduleTakeBackup": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "operationId": "ProvisionedVirtualMachine_ScheduleProvisionedVirtualMachinesTakeBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ScheduleProvisionedVMTaskDetailTakeBackupRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TakeVMBackupTaskDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/$search": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Perform an advanced search for Provisioned virtual machines.", "description": "Perform an advanced search for Provisioned virtual machines. Note that some combinations\nof search parameters may result in slow performance.", "operationId": "ProvisionedVirtualMachine_DoProvisionedVirtualMachineSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of machines returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "default": "VMSid,VMName,ProvisioningSchemeName", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the search machines will be executed as a background task.\nThe task will have JobType SearchProvisionedVirtualMachines.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 }, { "name": "skip", "in": "query", "description": "The number of machines to skip.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 6 }, { "name": "includingImportedMachine", "in": "query", "description": "Indicate whether the imported machine records will be included.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 7 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of Provisioned virtual machines that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}": { "patch": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Changes the configuration for a specific provisioned virtual machine.", "description": "Any configuration changes made will not apply right away to the machine.\nTo apply the updates, set an update time window for the machine with Set-ProvVMUpdateTimeWindow and start the machine within the window.", "operationId": "ProvisionedVirtualMachine_UpdateProvisionedVirtualMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Virtual Machine Sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the update operation will be created within a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Properties of the provisioned virtual machine to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateProvisionedVirtualMachineRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{VMSid}": { "get": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Get a Provisioned machine using VMSid.", "operationId": "ProvisionedVirtualMachine_GetProvisionedVirtualMachineDetails", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "VMSid", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "includingImportedMachine", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "A Provisioned virtual machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionedVirtualMachineDetailsResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/$applyUpdate": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Performs an immediate update of the configuration for a specific provisioned virtual machine.", "description": "Provides the ability to synchronize the properties of existing virtual machines with any changes\noccurred on the provisioning scheme with Set-ProvScheme and any configuration applied with Set-ProvVM.", "operationId": "ProvisionedVirtualMachine_ApplyProvisionedVirtualMachineConfigurationUpdate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Virtual Machine Sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the update operation will be created within a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/$confirmProvisioningOperationEvents": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Confirm provisioning operation events for a virtual machine.", "operationId": "ProvisionedVirtualMachine_ConfirmProvisionedVirtualMachineOperationEvents", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Virtual machine Sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the event confirmation will be run within a background task.\nThe task will have JobType ConfirmProvisionedVirtualMachineOperationEvents.\nWhen the task is complete it will redirect to\nGetTaskAsync.\nThe job's Parameters will contain properties:\n\n* _vmSid_ - Sid of the provisioned virtual machine to confirm operation events.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/$createConfigurationAndScheduleHardwareUpdate": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Create a configuration for a provisioned virtual machine and schedule a VM hardware update.", "operationId": "ProvisionedVirtualMachine_CreateProvisionedVMConfigurationAndScheduleUpdate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Virtual machine Sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the action will be created within a background task.\nThe task will have JobType CreateProvisionedVMConfigurationAndScheduleUpdate.\nWhen the task is complete it will redirect to\nGetTaskAsync.\nThe job's Parameters will contain properties:\n\n* _request_ - Details to create the virtual machine configuration and\nto schedule a hardware update.\n* _taskId_ - Id of the task created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details to create the virtual machine configuration and to schedule a hardware update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateProvisionedVMConfigurationAndScheduleUpdateRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HardwareVmUpdateTaskDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/$resetProvVmOSDisk": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Performs an immediate reset of the OS disk for a specific provisioned virtual machine.", "description": "Provides the ability to reset the OS disk with Reset-ProvVMDisk -OS.", "operationId": "ProvisionedVirtualMachine_ResetProvisionedVirtualMachineOSDisk", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Virtual Machine Sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the update operation will be created within a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/$scheduleHardwareUpdate": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Schedule a hardware update for a provisioned VM.", "operationId": "ProvisionedVirtualMachine_ScheduleProvisionedVirtualMachineHardwareUpdate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Virtual machine Sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the hardware update will be create within a background task.\nThe task will have JobType ScheduleProvisionedVirtualMachineHardwareUpdate.\nWhen the task is complete it will redirect to\nGetTaskAsync.\nThe job's Parameters will contain properties:\n\n* _request_ - Details to create the hardware update.\n* _taskId_ - Id of the task created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details to create the hardware update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ScheduleProvisionedVMTaskHardwareUpdateRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HardwareVmUpdateTaskDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/$scheduleRestoreToBackup": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "operationId": "ProvisionedVirtualMachine_ScheduleProvisionedVirtualMachineRestoreToBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ScheduleProvisionedVMTaskDetailRestoreBackupRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RestoreVmBackupTaskDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/configurations": { "get": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Get provisioned virtual machine configurations.", "operationId": "ProvisionedVirtualMachine_GetProvisionedVirtualMachinesConfigurations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Provisioned virtual machine sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of provisioned virtual machine configurations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisionedVirtualMachineConfigurationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Create a configuration version for a provisioned virtual machine.", "operationId": "ProvisionedVirtualMachine_CreateProvisionedVirtualMachineConfiguration", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Virtual machine Sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the virtual machine configuration will be create within a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details to create the virtual machine configuration.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateProvisionedVirtualMachineConfigurationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisionedVirtualMachineConfigurationResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedvirtualmachines/{vmSid}/configurations/{versionNumber}": { "delete": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Delete a provisioned vm configuration.", "operationId": "ProvisionedVirtualMachine_DeleteProvisionedVirtualMachineConfiguration", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "virtual machine sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumber", "in": "path", "required": true, "description": "the version number of the provisioned vm configuration.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "if `true`, the deletion of provisioned vm configuration will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/configurations/{versionNumber}": { "get": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Get the provisioned virtual machine configuration.", "operationId": "ProvisionedVirtualMachine_GetProvisionedVirtualMachinesConfiguration", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Provisioned virtual machine sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumber", "in": "path", "required": true, "description": "The version of provisioned virtual machine configuration.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details of provisioned virtual machine configuration.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisionedVirtualMachineConfigurationResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedvirtualmachines/{vmSid}/configurations/{versionNumber}/deletePreview": { "get": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Get the provisioned virtual machine configuration delete preview.", "description": "Get the related info that are using a provisioned virtual machine configuration.", "operationId": "ProvisionedVirtualMachine_GetProvisionedVirtualMachineConfigurationDeletePreview", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "Provisioned virtual machine Sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumber", "in": "path", "required": true, "description": "The version of provisioned virtual machine configuration.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Delete preview of a provisioned virtual machine configuration.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisionedVirtualMachineConfigurationDeletePreviewResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisionedVirtualMachines/{vmSid}/provisionedBackups": { "get": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Get all provisioned backups associated with the provisioned virtual machine.", "description": "Get all provisioned backups associated with the provisioned virtual machine.", "operationId": "ProvisionedVirtualMachine_GetProvisionedVirtualMachineBackups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "vmSid", "in": "path", "required": true, "description": "The SID of the virtual machine.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of backups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisionedBackupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningOperationEvent/$search": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Perform an advanced search for MCS Operation Event.", "description": "Perform an advanced search for MCS error info. Note that some combinations\nof search parameters may result in slow performance.", "operationId": "ProvisionedVirtualMachine_DoProvisioningOperationEventSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of machines returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "default": "EventRecordId,EventSeverity,EventCategory,EventMessage,EventState,EventDateTime", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the search machines will be executed as a background task.\nThe task will have JobType SearchProvisioningOperationEvent.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 }, { "name": "skip", "in": "query", "description": "The number of machines to skip.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 6 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningOperationEventSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of provisioning operation event that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisioningOperationEventSearchResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningOperationEvent/{eventRecordId}": { "delete": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Remove a MCS Operation Event.", "operationId": "ProvisionedVirtualMachine_RemoveProvisioningOperationEvents", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "eventRecordId", "in": "path", "required": true, "schema": { "title": "Int64", "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the remove task will be a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningOperationEvent/Confirm": { "post": { "tags": [ "ProvisionedVirtualMachine APIs" ], "summary": "Confirm a MCS Operation Event.", "operationId": "ProvisionedVirtualMachine_ConfirmProvisioningOperationEvents", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the confirm task will be a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "requestBody": { "x-name": "provOperationEventConfirmRequestModel", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningOperationEventConfirmRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/$search": { "post": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Perform an advanced search for Provisioning Scheme.", "description": "Perform an advanced search for Provisioning Scheme. Note that some combinations\nof search parameters may result in slow performance.", "operationId": "ProvisioningSchemes_DoProvisioningSchemeSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of provisioning scheme returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server.", "schema": { "title": "String", "type": "string", "default": "ActivationType,Id,CpuCount,DiskSize,HostingUnitId,MemoryMB,Name,Persistency,UseWriteBackCache,Version,WriteBackCacheDiskSize,WriteBackCacheMemorySize", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the search provision scheme will be executed as a background task.\nThe task will have JobType SearchProvisioningScheme.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 }, { "name": "skip", "in": "query", "description": "The number of provisioning scheme to skip.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 6 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of Provisioning scheme that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisioningSchemeSearchResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}": { "get": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Get the details of a provisioning scheme.", "description": "This API provides the details of a provisioning scheme, including information about\nthe disks, images, templates, MCS IO, network, scheme, and security\ninformation.", "operationId": "ProvisioningSchemes_GetProvisioningSchemesDetails", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the get of provisioning scheme details will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "The details of the provisioning scheme.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisioningSchemeDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/$confirmProvisioningOperationEvents": { "post": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Confirm provisioning operation events for a provisioning scheme.", "operationId": "ProvisioningSchemes_ConfirmProvisioningSchemeOperationEvents", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the event confirmation will be run within a background task.\nThe task will have JobType ConfirmProvisioningSchemeOperationEvents.\nWhen the task is complete it will redirect to\nGetTaskAsync.\nThe job's Parameters will contain properties:\n\n* _nameOrId_ - name or Id of the provisioning scheme to confirm operation events.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/$confirmVirtualMachineProvisioningOperationEvents": { "post": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Confirm specific provisioning operation events for virtual machines in a provisioning scheme.", "operationId": "ProvisioningSchemes_ConfirmProvisioningSchemeVirtualMachineOperationEvents", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "operationType", "in": "query", "required": true, "description": "The operation type to confirm.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "operationName", "in": "query", "required": true, "description": "The operation name to confirm.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the event confirmation will be run within a background task.\nThe task will have JobType ConfirmProvisioningSchemeVirtualMachineOperationEvents.\nWhen the task is complete it will redirect to\nGetTaskAsync.\nThe job's Parameters will contain properties:\n\n* _nameOrId_ - name or Id of the provisioning scheme to confirm operation events.\n* operationType - the operation type to confirm.\n* operationName - the operation name to confirm.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/$scheduleHardwareUpdate": { "post": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Schedule a hardware update for a machine catalog.", "operationId": "ProvisioningSchemes_ScheduleProvisioningSchemeHardwareUpdate", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the hardware update will be create within a background task.\nThe task will have JobType ScheduleProvisioningSchemeHardwareUpdate.\nWhen the task is complete it will redirect to\nGetTaskAsync.\nThe job's Parameters will contain properties:\n\n* _request_ - Details about the request to create a one-time schedule to\ntake backup for the provisioning scheme.\n* _taskId_ - Id of the task created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details to create the hardware update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ScheduleProvisioningSchemeTaskHardwareUpdateRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/HardwareSchemeUpdateTaskDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/$scheduleTakeBackup": { "post": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Schedule a maintenance cycle to take backup for all virtual machines in the provisioning scheme.", "description": "Schedule a maintenance cycle to take backup for all virtual machines in the provisioning scheme.", "operationId": "ProvisioningSchemes_ScheduleProvisioningSchemeTakeBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the operation will be performed as a background task.\nThe task will have JobType ScheduleTakeProvisionedBackup.\nWhen the task is complete it will redirect to\nGetTaskAsync.\nThe job's Parameters will contain properties:\n\n* _request_ - Details about the request to create a one-time schedule to\ntake backup for the provisioning scheme.\n* _taskId_ - Id of the task created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details about the request to create a one-time schedule\n to take backup for the provisioning scheme.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ScheduleProvisioningSchemeTaskDetailTakeBackupRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TakeVMBackupTaskDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/configurations": { "get": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Get provisioning scheme configurations.", "operationId": "ProvisioningSchemes_GetProvisioningSchemeConfigurations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of provisioning scheme configurations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeConfigurationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Create a configuration version for a provisioning scheme.", "operationId": "ProvisioningSchemes_CreateProvisioningSchemeConfiguration", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the provisioning scheme to add configuration version to.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the provisioning scheme configuration will be create within a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details to create the provisioning scheme configuration.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateProvisioningSchemeConfigurationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeConfigurationResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/configurations/{versionNumber}": { "delete": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Delete a provisioning scheme configuration.", "operationId": "ProvisioningSchemes_DeleteProvisioningSchemeConfiguration", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumber", "in": "path", "required": true, "description": "The version number of the provisioning scheme configuration.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the deletion of provisioning scheme configuration will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Get the provisioning scheme configuration.", "operationId": "ProvisioningSchemes_GetProvisioningSchemeConfiguration", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumber", "in": "path", "required": true, "description": "The version of provisioning scheme configuration.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details of provisioning scheme configurations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeConfigurationResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/configurations/{versionNumber}/deletePreview": { "get": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Get the provisioning scheme configuration delete preview.", "description": "Get the related info that are using a provisioning scheme configuration.", "operationId": "ProvisioningSchemes_GetProvisioningSchemeConfigurationDeletePreview", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "versionNumber", "in": "path", "required": true, "description": "The version of provisioning scheme configuration.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Delete preview of a provisioning scheme configuration.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeConfigurationDeletePreviewResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/details": { "get": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Get the details of a provisioning scheme.", "description": "This API provides the details of a provisioning scheme, including information about\nthe disks, images, templates, MCS IO, network, scheme, and security\ninformation.", "operationId": "ProvisioningSchemes_GetProvisioningSchemesDetails2", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the get of provisioning scheme details will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "The details of the provisioning scheme.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisioningSchemeDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/provisionedVirtualMachines/{vmNameOrSid}/$scheduleRestoreToBackup": { "post": { "tags": [ "ProvisioningSchemes APIs" ], "operationId": "ProvisioningSchemes_ScheduleProvisioningSchemeVirtualMachineRestoreToBackup", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "vmNameOrSid", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ScheduleProvisionedVMTaskDetailRestoreBackupRequestModel" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RestoreVmBackupTaskDetailResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/provisionedVirtualMachines/{vmNameOrSid}/provisionedBackups": { "get": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Get all provisioned backups associated with the provisioned virtual machine.", "description": "Get all provisioned backups associated with the provisioned virtual machine.", "operationId": "ProvisioningSchemes_GetProvisioningSchemeVirtualMachineBackups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "vmNameOrSid", "in": "path", "required": true, "description": "Provisioned virtual machine name or sid.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of backups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisionedBackupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/provisionedVirtualMachines/{vmSid}/configurationResultantSet": { "get": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Provides the ability get the resultant configuration properties for virtual machine created using Machine Creation Services.\nThis merges properties at the provisioning scheme level with those set on a machine with Set-ProvVM specifically.", "operationId": "ProvisioningSchemes_GetVMConfigurationResultantSet", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "vmSid", "in": "path", "required": true, "description": "Virtual machine SID.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the get of VM configuration set will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "A list of configurations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ProvisionedVirtualMachineConfigurationResultantSetResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/provisioningSchemes/{nameOrId}/tasks": { "get": { "tags": [ "ProvisioningSchemes APIs" ], "summary": "Get tasks associated with a provisioning scheme.", "operationId": "ProvisioningSchemes_GetProvisioningSchemesTasks", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Provisioning scheme name or id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the get tasks will run as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of tasks.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TaskResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/PvsStreaming/$checkDeviceCollectionName": { "post": { "tags": [ "PvsStreaming APIs" ], "summary": "Test the existence of a device collection by name.", "description": "Check for the existence of a device collection by name", "operationId": "PvsStreaming_TestDeviceCollectionExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "Name of the device collection and PVS site id.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DeviceCollectionNameCheckRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/PvsStreaming/Sites": { "get": { "tags": [ "PvsStreaming APIs" ], "summary": "Get the list of PVS sites.", "operationId": "PvsStreaming_GetPvsStreamingSites", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "farmId", "in": "query", "description": "PVS farm id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "200": { "description": "PvsStreamingSiteResponseModelCollection", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PvsStreamingSiteResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/PvsStreaming/Stores/{farmId}": { "get": { "tags": [ "PvsStreaming APIs" ], "summary": "Get the list of PVS stores.", "operationId": "PvsStreaming_GetPvsStreamingStores", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "farmId", "in": "path", "required": true, "description": "PVS farm id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "pvsSiteId", "in": "query", "description": "PVS site id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "PvsStreamingStoreResponseModelCollection", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PvsStreamingStoreResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/PvsStreaming/vDisks": { "get": { "tags": [ "PvsStreaming APIs" ], "summary": "Get the list of PVS vDisks.", "operationId": "PvsStreaming_GetPvsStreamingVDisks", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "farmId", "in": "query", "description": "PVS farm id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "pvsSiteId", "in": "query", "description": "PVS site id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "storeId", "in": "query", "description": "PVS store id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "diskLocatorId", "in": "query", "description": "PVS vDisk id.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "PvsStreamingVDiskResponseModelCollection", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PvsStreamingVDiskResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/RebootSchedules": { "get": { "tags": [ "RebootSchedules APIs" ], "summary": "Get all reboot schedules in the site.", "description": "Get a list of reboot schedules from all delivery groups.", "operationId": "RebootSchedules_GetRebootSchedules", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "List of reboot schedules.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RebootScheduleResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/recommendations": { "get": { "tags": [ "Recommendations APIs" ], "summary": "Get all the recommendations.", "operationId": "Recommendations_GetRecommendations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of recommendations returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, recommendations will be fetched asynchronously.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of the recommendations.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecommendationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Recommendations APIs" ], "summary": "Set the state of a list of recommendations.", "operationId": "Recommendations_SetRecommendations", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "requestBody": { "x-name": "request", "description": "The detail of the recommendations to be updated.\nSetRecommendationsRequestModel", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SetRecommendationsRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/recommendations/{id}": { "patch": { "tags": [ "Recommendations APIs" ], "summary": "Set the state of the specified recommendation.", "operationId": "Recommendations_SetRecommendation", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "The recommendation id", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "The detail of the recommendation to be updated.\nSetRecommendationRequestModel", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SetRecommendationRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions": { "get": { "tags": [ "Sessions APIs" ], "summary": "Get all sessions in the site.", "description": "Get all the sessions in the site. Note that the response\nmay not contain the entire list of sessions; if this happens the\nresponse will have a ContinuationToken\nwhich, if passed, will resume retrieving results from the original\nquery.", "operationId": "Sessions_GetSessions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of sessions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the get sessions will be executed as a background task.\nThe task will have JobType GetSessions.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ApplicationsInUse" } ], "responses": { "200": { "description": "List of sessions.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/$search": { "post": { "tags": [ "Sessions APIs" ], "summary": "Perform an advanced search for sessions.", "description": "Perform an advanced search for sessions. Note that some combinations\nof search parameters may result in slow performance.", "operationId": "Sessions_DoSessionSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "X-TimeZone", "in": "header", "description": "Time zone of the client. If specified, must be a valid Windows Id or Utc Offset from IANA (https://www.iana.org/time-zones) time zones.\r\nExample: UTC or +00:00", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of sessions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "async", "in": "query", "description": "If `true`, the search sessions will be executed as a background task.\nThe task will have JobType DoSessionSearch.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 5 }, { "name": "skip", "in": "query", "description": "The number of sessions to skip.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 6 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineAndSessionSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of sessions that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}": { "get": { "tags": [ "Sessions APIs" ], "summary": "Get details of a single session.", "description": "Get details of a single session.", "operationId": "Sessions_GetSession", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "The requested fields.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Id,Uid,ApplicationsInUse" } ], "responses": { "200": { "description": "Details of the session.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/$disconnect": { "post": { "tags": [ "Sessions APIs" ], "summary": "Disconnect a session.", "description": "Disconnect a session.", "operationId": "Sessions_DisconnectSession", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session to disconnect.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the session will be disconnected as a background task.\nThe task will have JobType .\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:\n\n\n* _Id_ - ID of the session being disconnected.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details of the session.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/$hide": { "post": { "tags": [ "Sessions APIs" ], "summary": "Hide a session", "operationId": "Sessions_HideSession", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session to hide or unhide.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the session will be hidden as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/$logoff": { "post": { "tags": [ "Sessions APIs" ], "summary": "Logoff a session.", "description": "Logoff a session.", "operationId": "Sessions_LogoffSession", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session to log off.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the session will be logged off as a background task.\nThe task will have JobType .\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:\n\n\n* _Id_ - ID of the session being logged off.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/$sendMessage": { "post": { "tags": [ "Sessions APIs" ], "summary": "Send a message to a session.", "description": "Send a message to a session.", "operationId": "Sessions_SendSessionMessage", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session to send a message to.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the message will be sent as a background task.\nThe task will have JobType .\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:\n\n\n* _Id_ - ID of the session to which a message is being sent.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "message", "description": "Details of the message to send.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SendMessageRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Details of the session.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/$startRecording": { "post": { "tags": [ "Sessions APIs" ], "summary": "start recording for a session.", "description": "start recording for a session.", "operationId": "Sessions_StartSessionRecording", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "notifyUser", "in": "query", "description": "Whether to notify session user or not.", "schema": { "title": "Boolean", "type": "boolean", "default": true, "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the session will be recorded as a background task.\nThe task will have JobType .\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:\n\n\n* _Id_ - ID of the session.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Details of the session.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/$stopRecording": { "post": { "tags": [ "Sessions APIs" ], "summary": "stop recording for a session.", "description": "stop recording for a session.", "operationId": "Sessions_StopSessionRecording", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the session will be recorded as a background task.\nThe task will have JobType .\nWhen the task is complete it will redirect to\n.\nThe job's will contain properties:\n\n\n* _Id_ - ID of the session.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "Details of the session.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/$unhide": { "post": { "tags": [ "Sessions APIs" ], "summary": "Unhide a session", "operationId": "Sessions_UnhideSession", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session to hide or unhide.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the session will be hidden as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/Applications": { "get": { "tags": [ "Sessions APIs" ], "summary": "Get the list of applications running within a session.", "description": "Get the list of applications running within a session.", "operationId": "Sessions_GetSessionApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the get applications will be executed as a background task.\nThe task will have JobType GetSessionApplications.\nWhen the task is complete it will redirect to\nGetJobResults.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the session being queried.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/{id}/Machine": { "get": { "tags": [ "Sessions APIs" ], "summary": "Get the details of the machine on which a session is running.", "description": "Get the details of the machine on which a session is running.", "operationId": "Sessions_GetSessionMachine", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the session.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the machine.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sessions/RecordingStatus": { "get": { "tags": [ "Sessions APIs" ], "summary": "get session recording status of a session.", "description": "get session recording status of a session.", "operationId": "Sessions_GetSessionRecordingStatus", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "query", "required": true, "description": "ID of the session.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionRecordingStatusResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/SessionsV2": { "get": { "tags": [ "Sessions APIs" ], "summary": "The V2 of get all sessions in the site.", "description": "Get all the sessions in the site with default response fields if no fields parameters specified.\nNote that the response\nmay not contain the entire list of sessions; if this happens the\nresponse will have a ContinuationToken\nwhich, if passed, will resume retrieving results from the original\nquery.", "operationId": "Sessions_GetSessionsV2", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of sessions returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the get sessions will be executed as a background task.\nThe task will have JobType GetSessions.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Id,Uid,ApplicationsInUse" } ], "responses": { "200": { "description": "List of sessions.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SessionResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites": { "get": { "tags": [ "Sites APIs" ], "summary": "Get the list of sites that are available to the customer and visible to the admin.", "operationId": "Sites_GetSites", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "List of sites.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}": { "get": { "tags": [ "Sites APIs" ], "summary": "Get the details about a single site.", "operationId": "Sites_GetSite", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Site details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}/$test": { "post": { "tags": [ "Sites APIs" ], "summary": "Run tests on a site and create a test report.", "description": "Run tests on a site and create a test report. Obtain the most recent report\nfrom GetSiteTestReport.", "operationId": "Sites_TestSite", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tests will run as a background task. This is recommended as the\ntests may take some time to run, and if it exceeds 90 seconds the request may\ntime out. The task will have JobType TestSite.\nWhen the task is complete it will redirect to\nGetJobResults. The job's\nParameters will contain properties:\n\n* _Id_ - ID of the site being tested.\n* _Name_ - Name of the site being tested.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "fields", "in": "query", "description": "A comma-separated list of properties to include in the response. For example, 'TestReport' to include the detailed test report.\nIf null or empty, a default set of properties will be returned.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Site test details.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SiteTestResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}/ErrorWarning": { "get": { "tags": [ "Sites APIs" ], "summary": "Get number of errors and warnings for the specified objects in the site.", "operationId": "Sites_GetSiteErrorWarning", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "To specify the object for which the number of the errors and warnings are reported.\n Otherwise, the number of errors and warning will be reported for all objects.\n The value should be a comma-separated list of object types.\n Supported object types are: MachineCatalog, DeliveryGroup, Machine, Hypervisor, Image, Zone, Site\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "Machine,DeliveryGroup,MachineCatalog" }, { "name": "async", "in": "query", "description": "If `true`, to get the number of error and warning will be done as a background task.\n The task will have JobType GetSiteErrorWarning\n ", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorWarningResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}/MultipleRemotePCAssignments": { "get": { "tags": [ "Sites APIs" ], "summary": "Get multi-user auto-assignment for Remote PC Access.", "operationId": "Sites_GetMultipleRemotePCAssignments", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The result indicating if allow multi-user auto-assignment for Remote PC Access.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "title": "Boolean", "type": "boolean" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Sites APIs" ], "summary": "Update multi-user auto-assignment for Remote PC Access.", "operationId": "Sites_PatchMultipleRemotePCAssignments", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "allow", "in": "query", "required": true, "description": "specify if allow multi-user auto-assignment for Remote PC Access.", "schema": { "title": "Boolean", "type": "boolean" }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}/SessionsTrend": { "get": { "tags": [ "Sites APIs" ], "summary": "Get the sessions trend", "operationId": "Sites_GetSessionsTrend", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The site name or ID.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "startDate", "in": "query", "required": true, "description": "The start date of sessions trend to query, for example '2021-11-01T12:00:00'.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "endDate", "in": "query", "required": true, "description": "The end date of sessions trend to query, for example '2021-11-08T12:00:00'.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "intervalLength", "in": "query", "required": true, "description": "The minutes interval to query.", "schema": { "title": "Int32", "type": "integer", "format": "int32" }, "x-position": 5 } ], "responses": { "200": { "description": "", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionsTrendResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}/Settings": { "get": { "tags": [ "Sites APIs" ], "summary": "Get the settings for the site.", "operationId": "Sites_GetSiteSettings", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "fields", "in": "query", "description": "To specify the object for which the settings are returned.\nThe value should be a comma-separated list of object types.\nSupported object types are: DnsResolutionEnabled, TrustRequestsSentToTheXmlServicePort, UseVerticalScalingForRdsLaunches, WebUiPolicySetEnabled, ConsoleInactivityTimeoutMinutes\nCloud-Only: MultiTenantServicesAccess\nOnPrem-Only: SupportedAuthenticators, AllowedCorsOriginsForIwa, DefaultDomain, XmlServicesSslConfigurations", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2, "example": "UseVerticalScalingForRdsLaunches,DnsResolutionEnabled,TrustRequestsSentToTheXmlServicePortEnabled" } ], "responses": { "200": { "description": "The result of site settings.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/SiteSettingsResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Sites APIs" ], "summary": "Update the site settings.", "operationId": "Sites_PatchSiteSettings", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "site settings request model.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditSiteSettingsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}/Status": { "get": { "tags": [ "Sites APIs" ], "summary": "Get the status of a site.", "operationId": "Sites_GetSiteStatus", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the site status query will be executed as a background task.\nThe task will have JobType GetSiteStatus.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "The site status.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteStatusResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}/TestReport": { "get": { "tags": [ "Sites APIs" ], "summary": "Get the most recent test report.", "description": "Get the test report from the last run of TestSite.", "operationId": "Sites_GetSiteTestReport", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Last test report. If no tests have been run, returns a 404 Not Found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Sites/{nameOrId}/UpgradePackageVersions": { "get": { "tags": [ "Sites APIs" ], "summary": "Get the latest released VDA upgrade package versions in the site.", "operationId": "Sites_GetUpgradePackageVersions", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the site.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The latest released VDA upgrade package version of each upgrade package type.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpgradePackageVersionResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/StoreFrontServers": { "get": { "tags": [ "StoreFrontServers APIs" ], "summary": "Get all StoreFront servers.", "description": "Get all StoreFront servers configured for use by hosted receivers\nwithin the site.", "operationId": "StoreFrontServers_GetStoreFrontServers", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "List of StoreFront servers.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StoreFrontServerResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "StoreFrontServers APIs" ], "summary": "Create a StoreFront server.", "description": "Create a StoreFront server for use by hosted receivers within the\nsite.", "operationId": "StoreFrontServers_CreateStoreFrontServer", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the StoreFront server (and associated objects) will be\ncreated as a background task. The task will have JobType\nCreateStoreFrontServer. When the task is\ncomplete it will redirect to\nGetStoreFrontServer. The job's\nParameters will contain properties:\n* _Name_ - Name of the StoreFront server being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details about the StoreFront server to create. Note: the\nId property must not be\nspecified in the request.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StoreFrontServerRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Details about the StoreFront server that was just created.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StoreFrontServerResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/StoreFrontServers/{nameOrId}": { "delete": { "tags": [ "StoreFrontServers APIs" ], "summary": "Delete a StoreFront server from the site.", "description": "Delete a StoreFront server from the site, regardless of whether it\nis being used by delivery groups or not. This removes the\nStoreFront server from hosted receivers.", "operationId": "StoreFrontServers_DeleteStoreFrontServer", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The name or ID of StoreFront server to be deleted.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the StoreFront server (and associated objects) will be\ndeleted as a background task. The task will have JobType\nDeleteStoreFrontServer. When the task is\ncomplete it will redirect to\nGetStoreFrontServers. The job's\nParameters will contain properties:\n* _Name_ - Name of the StoreFront server being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "StoreFrontServers APIs" ], "summary": "Get the details for a single StoreFront server.", "description": "Get a single StoreFront server configured for use by hosted\nreceivers within the site.", "operationId": "StoreFrontServers_GetStoreFrontServer", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The name or ID of the StoreFront server.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the StoreFront server.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StoreFrontServerResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "StoreFrontServers APIs" ], "summary": "Update a StoreFront server.", "description": "Update a StoreFront server.", "operationId": "StoreFrontServers_UpdateStoreFrontServer", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the StoreFront server to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the StoreFront server (and associated objects) will be\nupdated as a background task. The task will have JobType\nUpdateStoreFrontServer. When the task is\ncomplete it will redirect to\nGetStoreFrontServer. The job's\nParameters will contain properties:\n* _Name_ - Name of the StoreFront server being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Properties of the StoreFront server to update. Note: the\nId property must not be\nspecified in the request.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StoreFrontServerRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "New StoreFront server.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StoreFrontServerResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/StoreFrontServers/{nameOrId}/DeliveryGroups": { "get": { "tags": [ "StoreFrontServers APIs" ], "summary": "GET delivery groups details for a Storefront", "description": "GET delivery groups details for a Storefront", "operationId": "StoreFrontServers_GetStoreFrontDeliveryGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The id of the Storefront", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "The delivery groups for the Storefront with the given identifier", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/StoreFrontDeliveryGroupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags": { "get": { "tags": [ "Tags APIs" ], "summary": "Get the list of all tags in the site.", "operationId": "Tags_GetTags", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of tags returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 }, { "name": "fields", "in": "query", "description": "The required fields of tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3, "example": "Name,Id,Description" } ], "responses": { "200": { "description": "List of tags.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Tags APIs" ], "summary": "Create a tag.", "operationId": "Tags_CreateTag", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the tag will be created as a background task.\nThe task will have JobType CreateTag.\nWhen the task is complete it will redirect to\n\"GetTag(string)\".\nThe job's Parameters will contain properties:\n\n* _Name_ - Name of the tag being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details of the tag to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Details of the tag created.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags/{name}": { "head": { "tags": [ "Tags APIs" ], "summary": "Check for the existence of a tag by name.", "description": "Check for the existence of a tag by name.", "operationId": "Tags_CheckTagExists", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "name", "in": "path", "required": true, "description": "Name of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags/{nameOrId}": { "delete": { "tags": [ "Tags APIs" ], "summary": "Delete a tag.", "operationId": "Tags_DeleteTag", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tag will be deleted as a background task.\nThe task will have JobType DeleteTag.\nWhen the task is complete it will redirect to\nGetTagsAsync.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the tag being deleted,\n* _Name_ - Name of the tag being deleted.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 }, { "name": "force", "in": "query", "description": "For deleting the tag if true", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Tags APIs" ], "summary": "Get a single tag from the site.", "operationId": "Tags_GetTag", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "List of tags.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Tags APIs" ], "summary": "Update a tag.", "operationId": "Tags_PatchTag", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tag will be updated as a background task.\nThe task will have JobType UpdateTag.\nWhen the task is complete it will redirect to\n\"GetTag(string)\".\nThe job's Parameters will contain properties:\n \n* _Id_ - ID of the tag being updated,\n* _Name_ - Name of the tag being updated.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details of the tag to update.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TagRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Details of the tag updated.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModel" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags/{nameOrId}/ApplicationGroups": { "get": { "tags": [ "Tags APIs" ], "summary": "Get the application groups associated with a tag.", "operationId": "Tags_GetTagApplicationGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of application groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of application groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationGroupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags/{nameOrId}/Applications": { "get": { "tags": [ "Tags APIs" ], "summary": "Get the applications associated with a tag.", "operationId": "Tags_GetTagApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of applications returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of applications.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ApplicationResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "Tags APIs" ], "summary": "Associate a tag with applications.", "description": "Associate a tag with applications.", "operationId": "Tags_SetTagApplications", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType SetTagApplications.\nWhen the task is complete it will redirect to\nGetTagApplications.\nThe job's Parameters will contain properties:\n* _Id_ - ID of the tag being associated with applications,\n* _Name_ - Name of the tag being associated with applications.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The applications to tag. Any application\n not listed will be untagged if it was previously associated with the tag.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RefsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags/{nameOrId}/DeliveryGroups": { "get": { "tags": [ "Tags APIs" ], "summary": "Get the delivery groups associated with a tag.", "operationId": "Tags_GetTagDeliveryGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of delivery groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of delivery groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DeliveryGroupResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "put": { "tags": [ "Tags APIs" ], "summary": "Associate a tag with delivery groups.", "operationId": "Tags_SetTagDeliveryGroups", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the tags will be modified as a background task.\nThe task will have JobType SetTagDeliveryGroups.\nWhen the task is complete it will redirect to\nGetTagDeliveryGroups.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the tag being associated with delivery groups,\n* _Name_ - Name of the tag being associated with delivery groups.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The delivery groups to tag. Any delivery group\n not listed will be untagged if it was previously associated with the tag.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RefsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags/{nameOrId}/Desktops": { "get": { "tags": [ "Tags APIs" ], "summary": "Get the desktops( entitlement policy rules) associated with a tag.", "operationId": "Tags_GetTagDesktops", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of desktops( entitlement policy rules) returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of Desktops( entitlement policy rules).", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/DesktopResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags/{nameOrId}/MachineCatalogs": { "get": { "tags": [ "Tags APIs" ], "summary": "Get the machine catalogs associated with a tag.", "operationId": "Tags_GetTagMachineCatalogs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of machine catalogs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "List of machine catalogs.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineCatalogResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tags/{nameOrId}/Machines": { "get": { "tags": [ "Tags APIs" ], "summary": "Get the machines associated with a tag.", "operationId": "Tags_GetTagMachines", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the tag.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "limit", "in": "query", "description": "The max number of machines returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "fields", "in": "query", "description": "Optional filter, removing unspecified properties that otherwise would\nhave been sent by the server\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4, "example": "Uid,AgentVersion,AllocationType" } ], "responses": { "200": { "description": "List of machines.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/MachineResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tasks": { "get": { "tags": [ "Tasks APIs" ], "summary": "Get all tasks.", "description": "Get all tasks in the site.", "operationId": "Tasks_GetTasks", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "The max number of tasks returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of tasks.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tasks/$search": { "post": { "tags": [ "Tasks APIs" ], "summary": "Perform an advanced search for tasks.", "description": "Perform an advanced search for tasks.", "operationId": "Tasks_DoTaskSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the search tasks will be executed as a background task.\nThe task will have JobType DoTaskSearch.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TaskSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of tasks that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tasks/{id}": { "delete": { "tags": [ "Tasks APIs" ], "summary": "Delete a task.", "operationId": "Tasks_DeleteTask", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the task to delete.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "type", "in": "query", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/TaskType" } ] }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the task will be deleted as a background task.\nThe task will have JobType DeleteTask.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Tasks APIs" ], "summary": "Get details about a single task.", "description": "Get details about a single task by ID of task.", "operationId": "Tasks_GetTask", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "ID of the task.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "type", "in": "query", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/TaskType" } ] }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Task object for provisioned virtual machine hardware update.\nor\nTask object for machine catalog hardware update.\nor\nTask object for machine catalog image update.\nor\nTask object for provisioned VM backup.\nor\nTask object for provisioned VM restore.\nor\nTask object for reset OS disk, reset Identidy disk.\nor\nTask object for site backup.\nor\nDetails of task.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskDetailResponseModel" } } }, "x-expectedSchemas": [ { "description": "Task object for provisioned virtual machine hardware update.", "schema": { "nullable": true, "$ref": "#/components/schemas/HardwareVmUpdateTaskDetailResponseModel" } }, { "description": "Task object for machine catalog hardware update.", "schema": { "nullable": true, "$ref": "#/components/schemas/HardwareSchemeUpdateTaskDetailResponseModel" } }, { "description": "Task object for machine catalog image update.", "schema": { "nullable": true, "$ref": "#/components/schemas/ImageUpdateTaskDetaiResponseModel" } }, { "description": "Task object for provisioned VM backup.", "schema": { "nullable": true, "$ref": "#/components/schemas/TakeVMBackupTaskDetailResponseModel" } }, { "description": "Task object for provisioned VM restore.", "schema": { "nullable": true, "$ref": "#/components/schemas/RestoreVmBackupTaskDetailResponseModel" } }, { "description": "Task object for reset OS disk, reset Identidy disk.", "schema": { "nullable": true, "$ref": "#/components/schemas/MaintenanceCycleTaskDetailResponseModel" } }, { "description": "Task object for site backup.", "schema": { "nullable": true, "$ref": "#/components/schemas/SiteBackupTaskDetailResponseModel" } }, { "description": "Details of task.", "schema": { "nullable": true, "$ref": "#/components/schemas/TaskDetailResponseModel" } } ] }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Tasks APIs" ], "summary": "Update a task.", "description": "A task can only be updated when the task status is in Scheduled.\nfor types HardwareSchemeUpdate,\nHardwareVmUpdate, TakeVmBackup,\nRestoreVmBackup, ResetOsDisk,\nResetIdDisk.", "operationId": "Tasks_UpdateTask", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "The Id of the task to update.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the task will be updated within a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details to update the task. Note that each type of\ntask may require a different update model:\n* HardwareSchemeUpdate, HardwareVmUpdate,\nTakeVmBackup, RestoreVmBackup\nResetOsDisk, ResetIdDisk require a model of\ntype UpdateMaintenanceCycleTaskRequestModel.\n* SiteBackup requires a model of\ntype UpdateSiteBackupTaskRequestModel.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/UpdateTaskRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tasks/{id}/$cancel": { "post": { "tags": [ "Tasks APIs" ], "summary": "Cancel a task.", "description": "A task can only be cancelled when the task is not finished.", "operationId": "Tasks_CancelTask", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "The ID of the task to cancel.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "type", "in": "query", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/TaskType" } ] }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, the task will be cancelled within a background task.\nThe task will have JobType CancelTask.", "schema": { "title": "Boolean", "type": "boolean", "nullable": true }, "x-position": 3 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tasks/{id}/$restart": { "post": { "tags": [ "Tasks APIs" ], "summary": "Restart a task.", "description": "A task can only be restarted when the task status is in Cancelled,\nFailed, PartiallyCompleted.\nThe restart operation is supported only for types HardwareSchemeUpdate,\nHardwareVmUpdate, TakeVmBackup,\nRestoreVmBackup, ResetOsDisk, ResetIdDisk.", "operationId": "Tasks_RestartTask", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "description": "The ID of the task to restart.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the task will be restarted within a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "Details to restart the task. Note that each type of\ntask may require a different restart model:\n* HardwareSchemeUpdate, HardwareVmUpdate,\nTakeVmBackup, RestoreVmBackup\nResetOsDisk, ResetIdDisk require a model of\ntype RestartMaintenanceCycleTaskRequestModel.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/RestartTaskRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tasks/{id}/SubJobs": { "get": { "tags": [ "Tasks APIs" ], "summary": "List sub jobs of a task.", "description": "This API is supported only for types HardwareSchemeUpdate,\nHardwareVmUpdate, TakeVmBackup,\nRestoreVmBackup, ResetOsDisk, ResetIdDisk.", "operationId": "Tasks_GetTaskSubJobs", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "id", "in": "path", "required": true, "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "type", "in": "query", "schema": { "allOf": [ { "nullable": true, "$ref": "#/components/schemas/TaskType" } ] }, "x-position": 2 }, { "name": "async", "in": "query", "description": "If `true`, it will be queried as a background task.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "The max number of sub jobs returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 4 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "List of tasks.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSubJobResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Tasks/SubJobs/$search": { "post": { "tags": [ "Tasks APIs" ], "summary": "Perform an advanced search for task sub jobs.", "description": "Perform an advanced search for task sub jobs.", "operationId": "Tasks_DoTaskSubJobSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the search task sub jobs will be executed as a background task.\nThe task will have JobType DoTaskSubJobSearch.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the advanced search parameters for sub jobs.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TaskSubJobSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of task sub jobs that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSubJobResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/TimeZones/All": { "get": { "tags": [ "TimeZones APIs" ], "summary": "Get a list of time zones supported by the site.", "description": "Get a (non-exhaustive) list of time zones supported by the site,\nwith time zone names represented in the caller's locale.\n\n\nNote that all IANA (https://www.iana.org/time-zones) time zones are\nsupported as inputs to time zone APIs. However sometimes callers\nneed a suitable list of time zones to display as options within a\nUI. This API provides that capability. The options returned\nrepresent a reasonable palette of options for a caller to choose\nfrom when selecting a time zone.\n\n\nThe localized time zone names come from the Unicode CLDR\n(http://cldr.unicode.org/) project.", "operationId": "TimeZones_GetTimeZones", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "List of time zones.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/TimeZoneResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/tokens": { "get": { "tags": [ "Trust APIs" ], "summary": "Exchange the FMA token via Windows Authentication.\nKerberos or NTLM authentication required for current Web Api.", "operationId": "Trust_GetBearerTokenWithWindowsAuthentication", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "AuthTokenResponseModel object. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Trust APIs" ], "summary": "Exchange the FMA token by using the domain credential.\nBasic authentication required for current Web Api.", "operationId": "Trust_ExchangeToken", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "AuthTokenResponseModel object. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/tokens/$refresh": { "post": { "tags": [ "Trust APIs" ], "summary": "Refresh the auth token.", "operationId": "Trust_RefreshToken", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" } ], "responses": { "200": { "description": "AuthTokenResponseModel object. ", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthTokenResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/v1/DeliveryGroups": { "get": { "tags": [ "DeliveryGroups APIs" ], "summary": "Get all delivery groups.", "description": "Get delivery groups in the site.", "operationId": "DeliveryGroups_GetDeliveryGroups2", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "adminFolder", "in": "query", "description": "Optional folder path (URL-encoded) or ID. If not specified, all delivery groups will\nbe returned from all folders.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "schema": { "title": "Boolean", "type": "boolean", "default": false }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "The max number of delivery groups returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 3 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 4 }, { "name": "fields", "in": "query", "description": "Optional. A filter string containing object fields requested to be returned, the requested fields are separated by comma','.\n ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 5, "example": "Id,Uid,UserManagement" } ], "responses": { "200": { "description": "List of all delivery groups.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryGroupResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Zones": { "get": { "tags": [ "Zones APIs" ], "summary": "Get the list of all zones in the site.", "description": "Get the list of all zones in the site", "operationId": "Zones_GetZones", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of zones returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 }, { "name": "continuationToken", "in": "query", "description": "The continuationToken returned by the previous query.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 2 } ], "responses": { "200": { "description": "List of zones.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ZoneResponseModelCollection" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "post": { "tags": [ "Zones APIs" ], "summary": "Create a zone.", "operationId": "Zones_CreateZone", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, the zone will be created as a background task.\nThe task will have JobType CreateZone.\nWhen the task is complete it will redirect to\nGetZoneAsync.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the zone being created,\n* _Name_ - Name of the zone being created.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Details about the zone to create.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/CreateZoneRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Resource was created.", "headers": { "Location": { "description": "Location where the newly created resource resides.", "schema": { "type": "string" }, "example": "/services/myservice/widgets/1" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Zones/$removeItems": { "post": { "tags": [ "Zones APIs" ], "summary": "Remove items from a zone.", "operationId": "Zones_RemoveItemsFromZone", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "async", "in": "query", "description": "If `true`, items will be removed from the zone as a background task.\nThe task will have JobType RemoveItemsFromZone.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "The request.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ZonedItemsRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Zones/$search": { "post": { "tags": [ "Zones APIs" ], "summary": "Perform a basic search for zoned items.", "description": "Perform a basic search for zoned items.\nNote that the search action is used for items in zone, not for zone itself.", "operationId": "Zones_DoZoneSearch", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "limit", "in": "query", "description": "The max number of items of the same itemtype returned by this query.\nIf not specified, the server might use a default limit of 250 items.\nIf the specified value is larger than 1000, the server might reject the call.\nThe default and maximum values depend on server settings.", "schema": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "continuationToken", "in": "query", "description": "If a query cannot be completed, the response will have a\nContinuationToken set.\nTo obtain more results from the query, pass the\ncontinuation token back into the query to get the next\nbatch of results.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 3 }, { "name": "async", "in": "query", "description": "If `true`, the search zoned items will be executed as a background task.\nThe task will have JobType DoZoneSearch.\nWhen the task is complete it will redirect to\nGetJobResults.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 4 } ], "requestBody": { "x-name": "searchRequest", "description": "Specifies the basic search parameters.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ZonedItemSearchRequestModel" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "List of zoned items that match the search criteria.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZonedItemResponseModelCollection" } } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Zones/{nameOrId}": { "delete": { "tags": [ "Zones APIs" ], "summary": "Delete a zone.", "description": "Only if there is no items in the zone, we may delete a zone. Items include:\n- application\n- controller\n- host connection\n- machine catalog\n- user / user group", "operationId": "Zones_DeleteZone", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or id of the zone to be deleted. ", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the zone will be deleted as a background task.\nThe task will have JobType DeleteZone.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 2 } ], "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "get": { "tags": [ "Zones APIs" ], "summary": "Get a single zone from the site.", "description": "Get a single zone from the site", "operationId": "Zones_GetZone", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the zone.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Details of the zone.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ZoneDetailResponseModel" } } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } }, "patch": { "tags": [ "Zones APIs" ], "summary": "Edit a zone.", "operationId": "Zones_EditZone", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "Name or ID of the zone.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, the zone will be edited as a background task.\nThe task will have JobType EditZone.\nWhen the task is complete it will redirect to\nGetZoneAsync.\nThe job's Parameters will contain properties:\n\n* _Id_ - ID of the zone being edited,\n* _Name_ - Name of the zone being edited.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The EditZoneRequestModel.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/EditZoneRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Zones/{nameOrId}/$addItems": { "post": { "tags": [ "Zones APIs" ], "summary": "Add items into a zone.", "operationId": "Zones_AddItemsIntoZone", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The zone into which items will be added.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, items will be added into the zone as a background task.\nThe task will have JobType AddItemsIntoZone.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The request.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ZonedItemsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } }, "/Zones/{nameOrId}/$moveItems": { "post": { "tags": [ "Zones APIs" ], "summary": "Move items into a zone.", "operationId": "Zones_MoveItemsIntoZone", "parameters": [ { "name": "Citrix-CustomerId", "in": "header", "required": true, "description": "Citrix Customer ID. Default is 'CitrixOnPremises'", "schema": { "type": "string" }, "example": "CitrixOnPremises" }, { "name": "Citrix-InstanceId", "in": "header", "required": true, "description": "Citrix Instance (Site) ID.", "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "description": "User Agent type of the request.", "schema": { "type": "string" }, "example": "Mozilla/5.0" }, { "name": "Authorization", "in": "header", "description": "Citrix authorization header: CWSAuth Bearer={token}", "schema": { "type": "string" } }, { "name": "Citrix-TransactionId", "in": "header", "description": "Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.", "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "description": "Must accept application/json.", "schema": { "type": "string" }, "example": "application/json" }, { "name": "Citrix-Locale", "in": "header", "description": "Locale of the request.", "schema": { "type": "string" }, "example": "en-US" }, { "name": "nameOrId", "in": "path", "required": true, "description": "The zone into which items will be moved.", "schema": { "title": "String", "type": "string", "nullable": true }, "x-position": 1 }, { "name": "async", "in": "query", "description": "If `true`, items will be moved into the zone as a background task.\nThe task will have JobType MoveItemsIntoZone.", "schema": { "title": "Boolean", "type": "boolean", "default": false, "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The request.", "content": { "application/json": { "schema": { "nullable": true, "$ref": "#/components/schemas/ZonedItemsRequestModel" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Operation is successful with no response content.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "202": { "description": "Async request was accepted and is being processed.", "headers": { "Location": { "description": "Location where the async job completion status can be queried.", "schema": { "type": "string" }, "example": "Jobs/{id}" }, "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } } }, "400": { "description": "Caller passed an invalid input.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/outOfRange": { "value": { "type": "https://errors-api.cloud.com/common/outOfRange", "detail": "A parameter in the request is out of range", "parameters": [ { "name": "property", "value": "startTime" } ] } } } } } }, "401": { "description": "Caller did not present a valid bearer token.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authentication": { "value": { "type": "https://errors-api.cloud.com/common/authentication", "detail": "Missing or invalid authentication details", "parameters": [ { "name": "reason", "value": "missing" } ] } } } } } }, "403": { "description": "Caller is not authorized to perform the operation.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/authorization": { "value": { "type": "https://errors-api.cloud.com/common/authorization", "detail": "Access denied", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "404": { "description": "A referenced entity was not found.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notFound": { "value": { "type": "https://errors-api.cloud.com/common/notFound", "detail": "Widget not found", "parameters": [ { "name": "entityType", "value": "https://identifiers-api.cloud.com/example/widget" }, { "name": "id", "value": "guid1" } ] } } } } } }, "406": { "description": "Caller must specify utf-8 charset with the Accept header.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/notAcceptable": { "value": { "type": "https://errors-api.cloud.com/common/notAcceptable", "detail": "Must accept application/json media type", "parameters": [ { "name": "contentType", "value": "application/json" } ] } } } } } }, "409": { "description": "Caller requested an invalid relation to be created or deleted.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/optimisticConcurrency": { "value": { "type": "https://errors-api.cloud.com/common/optimisticConcurrency", "detail": "Widget X was modified, please try your changes again", "parameters": null } } } } } }, "415": { "description": "Caller must send request body in utf-8 and specify request Content-Type as utf-8.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/unsupportedMediaType": { "value": { "type": "https://errors-api.cloud.com/common/unsupportedMediaType", "detail": "Must use application/json;charset=utf-8 media type", "parameters": [ { "name": "mediaType", "value": "application/xml" } ] } } } } } }, "429": { "description": "Caller has made too many requests in a short period of time and is being rate-limited.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/rateLimitExceeded": { "value": { "type": "https://errors-api.cloud.com/common/rateLimitExceeded", "detail": "Rate limit exceeded; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "503": { "description": "Service is temporarily unable to process the request. Caller may attempt the operation again, with exponential back-off.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/serviceUnavailable": { "value": { "type": "https://errors-api.cloud.com/common/serviceUnavailable", "detail": "Service is unavailable; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } }, "500": { "description": "An unexpected server error occurred.", "headers": { "Citrix-TransactionId": { "description": "Transaction ID that is either provided by caller with the same request header or newly created.", "schema": { "type": "string" }, "example": "57AB53D9-589A-4AA8-8879-6B1DACF3A868" }, "Content-Type": { "description": "Response Content Type. Value is always 'application/json'.", "schema": { "type": "string" }, "example": "application/json" }, "X-Content-Type-Options": { "description": "Content type options. Value is always 'nosniff'.", "schema": { "type": "string" }, "example": "nosniff" }, "Content-Language": { "description": "Content language. Value is either 'en-US' or based on client language setting.", "schema": { "type": "string" }, "example": "en-US" }, "Cache-Control": { "description": "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'", "schema": { "type": "string" }, "example": "no-cache, no-store, must-revalidate" }, "Pragma": { "description": "Pragma. Value is always 'no-cache'.", "schema": { "type": "string" }, "example": "no-cache" }, "Citrix-FilterScope": { "description": "Optional filter scope for getting scoped objects.", "schema": { "type": "string" }, "example": "b79aadf4-a0e6-11eb-bcbc-0242ac130002" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "https://errors-api.cloud.com/common/internalServerError": { "value": { "type": "https://errors-api.cloud.com/common/internalServerError", "detail": "An internal server error has occurred; try again in 4 seconds", "parameters": [ { "name": "retryDelay", "value": "4" } ] } } } } } } } } } }, "components": { "schemas": { "AboutModel": { "title": "AboutModel", "type": "object", "description": "About model of current Orchestration instance.\n ", "additionalProperties": false, "properties": { "Commit": { "title": "String", "type": "string", "description": "The commit hash when building.\n ", "nullable": true }, "IsCloud": { "title": "Boolean", "type": "boolean", "description": "Indicates if the current environment is cloud." } } }, "AccountNamingSchemeType": { "title": "AccountNamingSchemeType", "type": "string", "description": "", "x-enumNames": [ "Unknown", "None", "Alphabetic", "Numeric" ], "enum": [ "Unknown", "None", "Alphabetic", "Numeric" ] }, "ActionCatalogCreationResponseModel": { "title": "ActionCatalogCreationResponseModel", "allOf": [ { "$ref": "#/components/schemas/ActionResponseModel" }, { "type": "object", "description": "Catalog creation action response model.", "additionalProperties": false, "properties": { "MasterImage": { "title": "String", "type": "string", "description": "The master image.", "nullable": true }, "MachineCreationData": { "description": "The machine creation data.", "nullable": true, "$ref": "#/components/schemas/ActionMachineCreationDetailsResponseModel" }, "Snapshot": { "title": "String", "type": "string", "description": "The snapshot.", "nullable": true } } } ] }, "ActionError": { "title": "ActionError", "type": "object", "description": "Action Error class.", "additionalProperties": false, "properties": { "Message": { "title": "String", "type": "string", "description": "The error message.", "nullable": true }, "StackTrace": { "title": "String", "type": "string", "description": "The stack trace.", "nullable": true }, "ErrorData": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The error data.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "InnerError": { "description": "The inner error.", "nullable": true, "$ref": "#/components/schemas/ActionError" } } }, "ActionErrorStatus": { "title": "ActionErrorStatus", "type": "string", "description": "Action error status.", "x-enumNames": [ "Unknown", "None", "Failed", "PartialFail" ], "enum": [ "Unknown", "None", "Failed", "PartialFail" ] }, "ActionFailedMachineOrAccountResponseModel": { "title": "ActionFailedMachineOrAccountResponseModel", "type": "object", "description": "Failed machine or account response model object class.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Failed machine or account.", "nullable": true }, "ActionError": { "description": "The failed action error.", "nullable": true, "$ref": "#/components/schemas/ActionError" } } }, "ActionMachineCreationDetailsResponseModel": { "title": "ActionMachineCreationDetailsResponseModel", "allOf": [ { "$ref": "#/components/schemas/ActionMachineOperationDetailsResponseModel" }, { "type": "object", "description": "Machine creation details response model class.", "additionalProperties": false, "properties": { "MachineRequested": { "title": "Int32", "type": "integer", "description": "The machine requested", "format": "int32" } } } ] }, "ActionMachineCreationResponseModel": { "title": "ActionMachineCreationResponseModel", "allOf": [ { "$ref": "#/components/schemas/ActionResponseModel" }, { "type": "object", "description": "Action machine creation response model.", "additionalProperties": false, "properties": { "MachineCreationData": { "description": "The machine creation data.", "nullable": true, "$ref": "#/components/schemas/ActionMachineCreationDetailsResponseModel" } } } ] }, "ActionMachineOperationDetailsResponseModel": { "title": "ActionMachineOperationDetailsResponseModel", "type": "object", "description": "Action machine operation details response model class. ", "additionalProperties": false, "properties": { "AdAccountAction": { "title": "String", "type": "string", "description": "Active directory account action.", "nullable": true }, "SuccessfulAccounts": { "title": "String[]", "type": "array", "description": "Successful accounts.", "nullable": true, "items": { "title": "String", "type": "string" } }, "SuccessfulMachines": { "title": "String[]", "type": "array", "description": "Successful machines. ", "nullable": true, "items": { "title": "String", "type": "string" } }, "FailedMachines": { "title": "ActionFailedMachineOrAccountResponseModel[]", "type": "array", "description": "Failed machines and Action errors.", "nullable": true, "items": { "$ref": "#/components/schemas/ActionFailedMachineOrAccountResponseModel" } }, "FailedAccounts": { "title": "ActionFailedMachineOrAccountResponseModel[]", "type": "array", "description": "Failed accounts and action errors.", "nullable": true, "items": { "$ref": "#/components/schemas/ActionFailedMachineOrAccountResponseModel" } } } }, "ActionMachineRemovalDetailsResponseModel": { "title": "ActionMachineRemovalDetailsResponseModel", "allOf": [ { "$ref": "#/components/schemas/ActionMachineOperationDetailsResponseModel" }, { "type": "object", "description": "Machine removal details response model class. ", "additionalProperties": false, "properties": { "VMAction": { "title": "String", "type": "string", "description": "The virtual machine actions. ", "nullable": true } } } ] }, "ActionMachineRemovalResponseModel": { "title": "ActionMachineRemovalResponseModel", "allOf": [ { "$ref": "#/components/schemas/ActionResponseModel" }, { "type": "object", "description": "The machine removal response model class.", "additionalProperties": false, "properties": { "MachineRemovalData": { "description": "The machine removal details response model.", "nullable": true, "$ref": "#/components/schemas/ActionMachineRemovalDetailsResponseModel" }, "DeleteVirtualMachines": { "title": "String", "type": "string", "description": "The delete virtual machines. ", "nullable": true } } } ] }, "ActionResponseModel": { "title": "ActionResponseModel", "type": "object", "description": "Action response model.", "additionalProperties": false, "properties": { "ActionId": { "title": "Guid", "type": "string", "description": "The action id.", "format": "guid" }, "ActionTargetName": { "title": "String", "type": "string", "description": "The action target name, it's the related catalog name.", "nullable": true }, "ActionTargetUid": { "title": "String", "type": "string", "description": "The action target uid, it's the related catalog uid.", "nullable": true }, "ActionTargetId": { "title": "String", "type": "string", "description": "The action target id, it's related on catalog id.", "nullable": true }, "ActionType": { "description": "The current action type.", "$ref": "#/components/schemas/ActionType" }, "CreationTime": { "title": "String", "type": "string", "description": "The action creation time.", "nullable": true }, "StartTime": { "title": "String", "type": "string", "description": "The action start time.", "nullable": true }, "FinishTime": { "title": "String", "type": "string", "description": "The action finish time.", "nullable": true }, "State": { "description": "The action state.", "$ref": "#/components/schemas/ActionState" }, "ErrorState": { "description": "The action error status.", "$ref": "#/components/schemas/ActionErrorStatus" }, "Progress": { "title": "Double", "type": "number", "description": "The progress of the action.", "format": "double" }, "ProgressMessage": { "title": "String", "type": "string", "description": "The progress message.", "nullable": true }, "TerminatingError": { "description": "The action terminating error.", "nullable": true, "$ref": "#/components/schemas/ActionError" }, "NonTerminatingErrors": { "title": "ActionError[]", "type": "array", "description": "The non terminating errors.", "nullable": true, "items": { "$ref": "#/components/schemas/ActionError" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the action.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "The scope of the catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "Tenants": { "title": "RefResponseModel[]", "type": "array", "description": "The tenant(s) that the hypervisor is assigned to. If `null`, the\nhypervisor is not assigned to tenants, and may be used by any\ntenant, including future added tenants.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "IsRunning": { "title": "Boolean", "type": "boolean", "description": "If the task is running." }, "MasterImage": { "title": "String", "type": "string", "description": "The master image.", "nullable": true }, "MachineCreationData": { "description": "The machine creation data.", "nullable": true, "$ref": "#/components/schemas/ActionMachineCreationDetailsResponseModel" }, "Snapshot": { "title": "String", "type": "string", "description": "The snapshot.", "nullable": true }, "MachineRemovalData": { "description": "The machine removal details response model.", "nullable": true, "$ref": "#/components/schemas/ActionMachineRemovalDetailsResponseModel" }, "DeleteVirtualMachines": { "title": "String", "type": "string", "description": "The delete virtual machines. ", "nullable": true } } }, "ActionResponseModelCollection": { "title": "ActionResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfActionResponseModel" }, { "type": "object", "description": "The collection of the ActionResponseModel.", "additionalProperties": false } ] }, "ActionState": { "title": "ActionState", "type": "string", "description": "The action state.", "x-enumNames": [ "Unknown", "NotStarted", "Running", "Canceled", "Completed", "Failed" ], "enum": [ "Unknown", "NotStarted", "Running", "Canceled", "Completed", "Failed" ] }, "ActionType": { "title": "ActionType", "type": "string", "description": "The action type.", "x-enumNames": [ "Unknown", "CreateItems", "DeleteItems", "CreateCatalog", "UpdateImage", "AddMachines", "RemoveMachines", "UpdateSkyWayImage", "DeleteMachines", "UpdatePvsScheme" ], "enum": [ "Unknown", "CreateItems", "DeleteItems", "CreateCatalog", "UpdateImage", "AddMachines", "RemoveMachines", "UpdateSkyWayImage", "DeleteMachines", "UpdatePvsScheme" ] }, "ActionUpdateImageResponseModel": { "title": "ActionUpdateImageResponseModel", "allOf": [ { "$ref": "#/components/schemas/ActionResponseModel" }, { "type": "object", "description": "Action update image response model object. ", "additionalProperties": false, "properties": { "MasterImage": { "title": "String", "type": "string", "description": "The master image.", "nullable": true }, "Snapshot": { "title": "String", "type": "string", "description": "The snapshot.", "nullable": true } } } ] }, "AddApplicationsRequestModel": { "title": "AddApplicationsRequestModel", "type": "object", "description": "Request object for adding applications to the site.", "additionalProperties": false, "properties": { "ExistingApplications": { "title": "String[]", "type": "array", "description": "List of existing applications to be added to the\nDeliveryGroups and/or ApplicationGroups.", "nullable": true, "example": [ "Name of an application" ], "items": { "title": "String", "type": "string" } }, "NewApplications": { "title": "CreateApplicationRequestModel[]", "type": "array", "description": "List of applications which should be created and added to the\nDeliveryGroups and/or ApplicationGroups.", "nullable": true, "items": { "$ref": "#/components/schemas/CreateApplicationRequestModel" } }, "ApplicationGroups": { "title": "String[]", "type": "array", "description": "List of application groups to add the\nExistingApplications and NewApplications\nto.", "nullable": true, "example": [ "Name of an application group" ], "items": { "title": "String", "type": "string" } }, "DeliveryGroups": { "title": "PriorityRefRequestModel[]", "type": "array", "description": "List of delivery groups to add the\nExistingApplications and NewApplications\nto.", "nullable": true, "items": { "$ref": "#/components/schemas/PriorityRefRequestModel" } } } }, "AddAppVServerRequestModel": { "title": "AddAppVServerRequestModel", "type": "object", "description": "Request model to add AppV server.", "additionalProperties": false, "required": [ "ManagementServer", "PublishingServer" ], "properties": { "ManagementServer": { "title": "String", "type": "string", "description": "The url of the App-V Management server that packages will be discovered from.", "maxLength": 250, "minLength": 1 }, "PublishingServer": { "title": "String", "type": "string", "description": "The url of the App-V Publishing server that packages will be discovered from.", "maxLength": 250, "minLength": 1 } } }, "AddIconRequestModel": { "title": "AddIconRequestModel", "type": "object", "description": "Request model for adding icons to the site\n ", "additionalProperties": false, "required": [ "RawData" ], "properties": { "RawData": { "title": "String", "type": "string", "description": "Raw icon data, Base64-encoded.\n ", "minLength": 1 }, "IconFormat": { "title": "String", "type": "string", "description": "Icon format.\n Must be: `{mime-type};{width}x{height}x{colordepth}`\n * _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n * _width_ and _height_ are specified in pixels.\n * _colordepth_ (optional) is either `8` or `24`.\n example: `\"image/png;32x32x24\"`\n Optional.If specified, the formatted icon data will be contained in the response.\n ", "nullable": true } } }, "AddLicenseRequestModel": { "title": "AddLicenseRequestModel", "type": "object", "description": "Request to add license.", "additionalProperties": false, "required": [ "LicenseFile", "FileName", "OverrideFile" ], "properties": { "LicenseFile": { "title": "String", "type": "string", "description": "Encoded Base64 for license file, and the format should be utf-8.", "minLength": 1 }, "FileName": { "title": "String", "type": "string", "description": "Licence file name to be added.", "maxLength": 256, "minLength": 1 }, "OverrideFile": { "title": "Boolean", "type": "boolean", "description": "Indicate if override exist license file when the license file already exists." } } }, "AddLicenseResponseModel": { "title": "AddLicenseResponseModel", "type": "object", "description": "Response model for Adding license.", "additionalProperties": false, "properties": { "IsLicenseImported": { "title": "Boolean", "type": "boolean", "description": "Indicate if the license file is imported successfully." } } }, "AddMachineToMachineCatalogDetailRequestModel": { "title": "AddMachineToMachineCatalogDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/AddMachineToMachineCatalogRequestModel" }, { "type": "object", "description": "Add a machine to a machine catalog.", "additionalProperties": false, "properties": { "PvsAddress": { "title": "String", "type": "string", "description": "IP address of the PVS server to be used. This only applies if the\nProvisioningType is PVS.", "maxLength": 255, "pattern": "UNKNOWN", "nullable": true }, "PvsDomain": { "title": "String", "type": "string", "description": "The domain of the PVS server to be used.\nThis only applies if the ProvisioningType is\nPVS.", "maxLength": 255, "pattern": "UNKNOWN", "nullable": true }, "PvsCollectionIds": { "title": "String[]", "type": "array", "description": "Collection IDs of PVS collections containing machines that should be\nadded to the catalog. This only applies if the\nProvisioningType is\nPVS, and is required in that case.\n\nEach item must be a valid PVS collection ID residing on the PVS\nserver located at the specified .", "nullable": true, "items": { "title": "String", "type": "string" } }, "MachineAccountCreationRules": { "description": "If specified, the machine account creation rules will be updated.\nIf not specified, the machine account creation rules will be left unchanged.", "nullable": true, "$ref": "#/components/schemas/UpdateMachineAccountCreationRulesRequestModel" }, "AddAvailableMachineAccount": { "description": "Active Directory machine account to add to the pool of available accounts that are to be used when machines are provisioned.", "nullable": true, "$ref": "#/components/schemas/MachineAccountRequestModel" } } } ] }, "AddMachineToMachineCatalogRequestModel": { "title": "AddMachineToMachineCatalogRequestModel", "type": "object", "description": "Add a machine to a machine catalog.", "additionalProperties": false, "properties": { "MachineName": { "title": "String", "type": "string", "description": "Specify the name of the machine to create (in the form 'domain\\machine'). A SID can also be specified.", "nullable": true, "example": "For example, test.local\\machine001" }, "AssignedClientName": { "title": "String", "type": "string", "description": "The client name to which this machine will be assigned. Machines can be assigned to\nmultiple users, a single client IP address, or a single client name, but only to one\nof these categories at a time.", "nullable": true, "example": "Name of an assigned client" }, "AssignedIPAddress": { "title": "String", "type": "string", "description": "The client IP address to which this machine will be assigned. Machines can be assigned\nto multiple users, a single client IP address, or a single client name, but only to\none of these categories at a time.", "nullable": true, "example": "For example, 1.1.1.1" }, "AssignedUsers": { "title": "String[]", "type": "array", "description": "The user(s) to whom this machine will be assigned. Machines can be assigned\nto multiple users, a single client IP address, or a single client name, but only to\none of these categories at a time.", "nullable": true, "example": [ "Name of an assigned user" ], "items": { "title": "String", "type": "string" } }, "HostedMachineId": { "title": "String", "type": "string", "description": "The unique ID by which the hypervisor recognizes the machine.\nOmit this for machines that are not power-managed.", "nullable": true, "example": "Id of a hosted machine" }, "HypervisorConnection": { "title": "String", "type": "string", "description": "Hypervisor connection to use for power management of the machine.", "nullable": true, "example": "Name of a hypervisor connection" }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the machine is initially in maintenance mode. A machine in maintenance mode is\nnot available for new sessions, and for managed machines all automatic power management is disabled.\nOptional; default is `false`.", "default": false, "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of machine.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "CloudPCProvisioningType": { "description": "Specifies provisioning type for Windows365 Cloud PC.\nThe values map to Graph API CloudPCProvisioningType enum. Possible values are:\nNotApplicable - Not a Windows365 Cloud PC machine.\nDedicated - Cloud PC provisioned by a dedicated license.\nSharedByUser - A dedicated Cloud PC provisioned for each user in the assignment group.\nSharedByEntraGroup - Cloud PC provisioned by a provisioning policy associated with Cloud PCs shared by a Microsoft Entra (Azure AD) group.\nOptional", "default": "NotApplicable", "nullable": true, "$ref": "#/components/schemas/Windows365ProvisioningType" } } }, "ADDomainResponseModel": { "title": "ADDomainResponseModel", "type": "object", "description": "Response model for ad domain.\n ", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Domain name", "nullable": true }, "ForestName": { "title": "String", "type": "string", "description": "Parent forest of this domain", "nullable": true } } }, "AdminFolderObjectIdentifier": { "title": "AdminFolderObjectIdentifier", "type": "string", "description": "Admin folder object identifier name, indicating which object will be contained in the folder.", "x-enumNames": [ "Unknown", "ContainsApplications", "ContainsMachineCatalogs", "ContainsDeliveryGroups", "ContainsApplicationGroups" ], "enum": [ "Unknown", "ContainsApplications", "ContainsMachineCatalogs", "ContainsDeliveryGroups", "ContainsApplicationGroups" ] }, "AdminFolderObjects": { "title": "AdminFolderObjects", "type": "string", "description": "Admin folder object name, indicating object in the folder.", "x-enumNames": [ "Unknown", "Applications", "MachineCatalogs", "DeliveryGroups", "ApplicationGroups" ], "enum": [ "Unknown", "Applications", "MachineCatalogs", "DeliveryGroups", "ApplicationGroups" ] }, "AdminFolderResponseModel": { "title": "AdminFolderResponseModel", "type": "object", "description": "Response object for an admin folder.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the admin folder.\nUsed to be: Uuid\nNeeds to be globally unique\nThis is likely to contain a guid but the property type should be string for future flexibility", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED. Use .` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use .", "nullable": true }, "Children": { "title": "RefResponseModel[]", "type": "array", "description": "Child folders.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "Name": { "title": "String", "type": "string", "description": "Name of the folder.", "nullable": true }, "Parent": { "description": "Parent folder.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "Path": { "title": "String", "type": "string", "description": "Full path to the folder.\nUsed to be: FullName", "nullable": true }, "TotalApplications": { "title": "Int32", "type": "integer", "description": "Total number of applications in the folder.", "format": "int32" }, "TotalMachineCatalogs": { "title": "Int32", "type": "integer", "description": "Total number of catalogs in the folder.", "format": "int32" }, "TotalApplicationGroups": { "title": "Int32", "type": "integer", "description": "Total number of application groups in the folder.", "format": "int32" }, "TotalDesktopGroups": { "title": "Int32", "type": "integer", "description": "Total number of desktop groups in the folder.", "format": "int32" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata map of the admin folder.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "AdminFolderResponseModelCollection": { "title": "AdminFolderResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAdminFolderResponseModel" }, { "type": "object", "description": "The collection for AdminFolderResponseModel", "additionalProperties": false } ] }, "AdministratorDeleteConcequenceResponseModel": { "title": "AdministratorDeleteConcequenceResponseModel", "type": "object", "additionalProperties": false, "properties": { "Consequence": { "$ref": "#/components/schemas/DeleteAdministratorConsequence" } } }, "AdministratorNamePreviewResponseModel": { "title": "AdministratorNamePreviewResponseModel", "type": "object", "description": "Response object for preview the administrator name.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "The requested administrator name for previewing.", "nullable": true }, "Error": { "title": "String", "type": "string", "description": "Localized error message when the request administrator request name is illegal. If the name is fine, the property should be null.", "nullable": true } } }, "AdministratorReportResponseModel": { "title": "AdministratorReportResponseModel", "type": "object", "additionalProperties": false, "properties": { "EncodedReport": { "title": "String", "type": "string", "description": "The encoded report as string. That is: RFC-4648-base-64(utf-8(html-report-content))", "nullable": true }, "Encoding": { "title": "String", "type": "string", "description": "The encoding of the EncodedReport.", "nullable": true }, "MediaType": { "title": "String", "type": "string", "description": "The media type of the report content;", "nullable": true } } }, "AdministratorResponseModel": { "title": "AdministratorResponseModel", "type": "object", "description": "Response object representing an administrator.", "additionalProperties": false, "required": [ "User", "ScopesAndRoles", "Enabled" ], "properties": { "User": { "description": "Details about the administrator user account.\nCHANGE: simplify the response model", "$ref": "#/components/schemas/IdentityUserResponseModel" }, "ScopesAndRoles": { "title": "AdministratorRightResponseModel[]", "type": "array", "description": "Rights associated with the administrator.\nCHANGE: was\npublic ScopeRolePair[] ScopesAndRoles { get; set; }", "items": { "$ref": "#/components/schemas/AdministratorRightResponseModel" } }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the administrator is enabled.\nDisabled administrators cannot administer the site\nUNLESS they are a member of a different user group\nwhich is granted access by a different administrator\nrecord." } } }, "AdministratorResponseModelCollection": { "title": "AdministratorResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAdministratorResponseModel" }, { "type": "object", "description": "Administrator response model collection", "additionalProperties": false } ] }, "AdministratorRightResponseModel": { "title": "AdministratorRightResponseModel", "type": "object", "description": "Response object for an administrator right, which is a combination\nof a role and a scope.", "additionalProperties": false, "required": [ "Scope", "Role" ], "properties": { "Scope": { "description": "Administrative scope. Scope defines the objects on which\nthe administrator can act, within the actions allowed by\nthe Role.", "$ref": "#/components/schemas/ScopeResponseModel" }, "Role": { "description": "Administrative role. Role defines the actions which the\nadministrator is allowed to take, on objects within the\nScope.", "$ref": "#/components/schemas/RoleResponseModel" } } }, "AdministratorRightResponseModelCollection": { "title": "AdministratorRightResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAdministratorRightResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "AdminRightRequestModel": { "title": "AdminRightRequestModel", "type": "object", "description": "Model for specifying administrator's rights.", "additionalProperties": false, "required": [ "Role", "Scope" ], "properties": { "Role": { "title": "String", "type": "string", "description": "Role. May be specified as Id or Name of the role.", "minLength": 1 }, "Scope": { "title": "String", "type": "string", "description": "Scope. May be specified as Id or Name of the scope.", "minLength": 1 } } }, "ADSCPConfigurationModel": { "title": "ADSCPConfigurationModel", "type": "object", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "The name of the service connection point entry in active directory.", "nullable": true }, "Keywords": { "title": "IList`1", "type": "array", "description": "The value of keywords attribute of the service connection point entry in active directory.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "AdvancedAccessPolicyRequestModel": { "title": "AdvancedAccessPolicyRequestModel", "type": "object", "description": "Request object for creating or updating an advanced access policy.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the broker access policy.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the advanced access policy.", "nullable": true, "example": "Name of the advanced access policy" }, "AllowHdxAccess": { "title": "Boolean", "type": "boolean", "description": "Whether to allow connections using HDX.\nWas: AllowsHdxAccess", "default": true, "nullable": true }, "AllowMachineRestart": { "title": "Boolean", "type": "boolean", "description": "Whether to allow users to self-service restart machines.", "default": true, "nullable": true }, "AllowRdpAccess": { "title": "Boolean", "type": "boolean", "description": "Whether to allow connections using RDP.\nWas: AllowsRdpAccess", "default": true, "nullable": true }, "AllowedConnection": { "description": "whether connections must be local or via Access Gateway,\nand if so whether specified SmartAccess tags must be provided\nby Access Gateway with the connection.", "default": "Filtered", "nullable": true, "$ref": "#/components/schemas/AllowedConnection" }, "AllowedUsers": { "description": "the behavior of the included users filter.", "default": "Filtered", "nullable": true, "$ref": "#/components/schemas/AllowedUser" }, "Description": { "title": "String", "type": "string", "description": "Description.", "nullable": true, "example": "Description of the advanced access policy" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the advanced access policy is enabled. If a policy is disabled\nit is not considered when evaluating whether a user may access the\ndelivery group.", "default": true, "nullable": true }, "ExcludedClientIPFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the ExcludedClientIPs\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "nullable": true }, "ExcludedClientIPs": { "title": "String[]", "type": "array", "description": "Specifies the client IPs which will be denied access to\nthe delivery group.", "nullable": true, "example": [ "For example", " 1.1.1.1" ], "items": { "title": "String", "type": "string" } }, "ExcludedClientNameFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the ExcludedClientNames\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "nullable": true }, "ExcludedClientNames": { "title": "String[]", "type": "array", "description": "Specifies the client names which will be denied access to\nthe delivery group.\nValidation: each specified item must have a maximum length and regex match", "nullable": true, "example": [ "For example", " client001.test.com" ], "items": { "title": "String", "type": "string" } }, "ExcludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the ExcludedSmartAccessTags\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "nullable": true }, "ExcludedSmartAccessTags": { "title": "SmartAccessTagRequestModel[]", "type": "array", "description": "Specifies the SmartAccess tags which will be denied access to\nthe delivery group, if any occur in those provided by\nNetScaler Gateway with the user's connection.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagRequestModel" } }, "ExcludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the ExcludedUsers filter is enabled.\nIf the filter is disabled, it is ignored when the access policy\nis evaluated.", "nullable": true }, "ExcludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the users and groups who are denied access to\nthe delivery group.", "nullable": true, "example": [ "Name of an excluded user" ], "items": { "title": "String", "type": "string" } }, "IncludedClientIPFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedClientIPs\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "nullable": true }, "IncludedClientIPs": { "title": "String[]", "type": "array", "description": "Specifies the client IPs which will be allowed access to\nthe delivery group.", "nullable": true, "example": [ "For example", " 2.2.2.2" ], "items": { "title": "String", "type": "string" } }, "IncludedClientNameFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedClientNames\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "nullable": true }, "IncludedClientNames": { "title": "String[]", "type": "array", "description": "Specifies the client names which will be granted access to\nthe delivery group.\nValidation: each specified item must have a maximum length and regex match", "nullable": true, "example": [ "For example", " client002.test.com" ], "items": { "title": "String", "type": "string" } }, "IncludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedSmartAccessTags\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "nullable": true }, "IncludedSmartAccessTags": { "title": "SmartAccessTagRequestModel[]", "type": "array", "description": "Specifies the SmartAccess tags which grant access to\nthe delivery group, if any occur in those provided by\nNetScaler Gateway with the user's connection.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagRequestModel" } }, "IncludedSmartAccessFilterType": { "description": "Indicates whether all tags present in IncludedSmartAccessTags must\nmatch tags provided by the user's connection to grant access (MatchAll),\nor whether any tag matching is sufficient(MatchAny).", "nullable": true, "$ref": "#/components/schemas/FilterMatchType" }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedUsers filter is enabled.\nIf the filter is disabled, it is ignored when the access policy\nis evaluated.", "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the users and groups who are granted access to\nthe delivery group.", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } }, "AppProtectionKeyLoggingRequired": { "title": "Boolean", "type": "boolean", "nullable": true }, "AppProtectionScreenCaptureRequired": { "title": "Boolean", "type": "boolean", "description": "Specifies whether screen capture app protection is required.", "nullable": true }, "IsContextualAppProtectionPolicy": { "title": "Boolean", "type": "boolean", "nullable": true }, "HdxSslEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether TLS encryption is enabled for sessions delivered\nfrom the rule’s delivery group.", "nullable": true } } }, "AdvancedAccessPolicyResponseModel": { "title": "AdvancedAccessPolicyResponseModel", "type": "object", "description": "Response object for an advanced access policy", "additionalProperties": false, "required": [ "Enabled" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the advanced access policy.", "nullable": true }, "AllowHdxAccess": { "title": "Boolean", "type": "boolean", "description": "Whether HDX connections are allowed to the delivery group.\nCHANGE: was:\npublic bool AllowsHdxAccess { get; set; }" }, "AllowMachineRestart": { "title": "Boolean", "type": "boolean", "description": "Whether users are allowed to self-service restart machines." }, "AllowRdpAccess": { "title": "Boolean", "type": "boolean", "description": "Whether RDP connections are allowed to the delivery group.\nCHANGE: was:\npublic bool AllowsRdpAccess { get; set; }" }, "AllowedConnection": { "description": "whether connections must be local or via Access Gateway,\nand if so whether specified SmartAccess tags must be provided\nby Access Gateway with the connection.", "$ref": "#/components/schemas/AllowedConnection" }, "AllowedUsers": { "description": "the behavior of the included users filter.", "$ref": "#/components/schemas/AllowedUser" }, "Description": { "title": "String", "type": "string", "description": "Description.", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the advanced access policy is enabled. If a policy is disabled\nit is not considered when evaluating whether a user may access the\ndelivery group." }, "IsBuiltIn": { "title": "Boolean", "type": "boolean", "description": "Whether the access policy is a built-in policy. If true , the policy\nis not allowed to remove or rename." }, "IsBroken": { "title": "Boolean", "type": "boolean", "description": "Whether the access policy is broken." }, "ExcludedClientIPFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the ExcludedClientIPs\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated." }, "ExcludedClientIPs": { "title": "String[]", "type": "array", "description": "The client IPs which will be denied access to\nthe delivery group.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ExcludedClientNameFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the ExcludedClientNames\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated." }, "ExcludedClientNames": { "title": "String[]", "type": "array", "description": "The client names which will be denied access to\nthe delivery group.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ExcludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the ExcludedSmartAccessTags\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated." }, "ExcludedSmartAccessTags": { "title": "SmartAccessTagResponseModel[]", "type": "array", "description": "The SmartAccess tags which will be denied access to\nthe delivery group, if any occur in those provided by\nNetScaler Gateway with the user's connection.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagResponseModel" } }, "ExcludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the ExcludedUsers filter is enabled.\nIf the filter is disabled, it is ignored when the access policy\nis evaluated." }, "ExcludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The users and groups who are denied access to\nthe delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "IncludedClientIPFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedClientIPs\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated." }, "IncludedClientIPs": { "title": "String[]", "type": "array", "description": "The client IPs which will be allowed access to\nthe delivery group.", "nullable": true, "items": { "title": "String", "type": "string" } }, "IncludedClientNameFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedClientNames\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated." }, "IncludedClientNames": { "title": "String[]", "type": "array", "description": "The client names which will be granted access to\nthe delivery group.", "nullable": true, "items": { "title": "String", "type": "string" } }, "IncludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedSmartAccessTags\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.\nCHANGE: was:\npublic bool AccessGatewayConnectionsUseFilters { get; set; }" }, "IncludedSmartAccessTags": { "title": "SmartAccessTagResponseModel[]", "type": "array", "description": "The SmartAccess tags which grant access to\nthe delivery group, if any occur in those provided by\nNetScaler Gateway with the user's connection.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagResponseModel" } }, "IncludedSmartAccessFilterType": { "description": "Indicates whether all tags present in IncludedSmartAccessTags must\nmatch tags provided by the user's connection to grant access (MatchAll),\nor whether any tag matching is sufficient(MatchAny).", "$ref": "#/components/schemas/FilterMatchType" }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedUsers filter is enabled.\nIf the filter is disabled, it is ignored when the access policy\nis evaluated." }, "AppProtectionKeyLoggingRequired": { "title": "Boolean", "type": "boolean", "description": "Indicates whether key logging app protection is required." }, "AppProtectionScreenCaptureRequired": { "title": "Boolean", "type": "boolean", "description": "Indicates whether screen capture app protection is required." }, "IsContextualAppProtectionPolicy": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the policy is used for contextual app protection." }, "HdxSslEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether TLS encryption is enabled for sessions delivered\nfrom the rule’s delivery group." }, "IncludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The users and groups who are granted access to\nthe delivery group.\nCHANGE: was:\npublic ADAccount[] IncludedUsers { get; set; }", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } } } }, "AdvancedAccessPolicyResponseModelCollection": { "title": "AdvancedAccessPolicyResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAdvancedAccessPolicyResponseModel" }, { "type": "object", "description": "Advanced access policy response model collection", "additionalProperties": false } ] }, "AdvisorRecommendationRequestModel": { "title": "AdvisorRecommendationRequestModel", "type": "object", "description": "Represents a request model for advisor recommendations.", "additionalProperties": false, "properties": { "RecommendationIdList": { "title": "IList`1", "type": "array", "description": "Gets or sets the list of recommendation IDs.", "nullable": true, "items": { "title": "String", "type": "string" } }, "AspectNameList": { "title": "IList`1", "type": "array", "description": "Gets or sets the list of aspect names.", "nullable": true, "items": { "title": "String", "type": "string" } }, "IsRunAllChecks": { "title": "Boolean", "type": "boolean", "description": "Gets or sets a value indicating whether to run all checks." } } }, "AdvisorRecommendationResponseModel": { "title": "AdvisorRecommendationResponseModel", "type": "object", "description": "Represents a response model for advisor recommendations.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Gets or sets the unique identifier for the recommendation.", "nullable": true }, "Recommendation": { "title": "String", "type": "string", "description": "Gets or sets the recommendation text.", "nullable": true }, "Details": { "title": "String", "type": "string", "description": "Gets or sets the details of the recommendation.", "nullable": true }, "Impact": { "title": "String", "type": "string", "description": "Gets or sets the impact of the recommendation.", "nullable": true }, "Aspect": { "title": "String", "type": "string", "description": "Gets or sets the aspect of the recommendation.", "nullable": true }, "Component": { "title": "String", "type": "string", "description": "Gets or sets the component related to the recommendation.", "nullable": true }, "IsRecommendationNeeded": { "title": "Boolean", "type": "boolean", "description": "Gets or sets if recommendation is triggered." }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "LastReportedTime": { "title": "String", "type": "string", "description": "Gets or sets the last reported time of the recommendation.", "nullable": true }, "AffectedResources": { "title": "Object", "type": "object", "description": "Gets or sets the affected resources by the recommendation.", "nullable": true }, "IsUsingCustomizedSettings": { "title": "Boolean", "type": "boolean", "description": "Gets or sets a value indicating whether this recommendation is using customized settings." }, "CustomizedSettings": { "title": "CustomizedSettingsModel[]", "type": "array", "description": "Gets or sets the customized settings used when generating this recommendation.\nOnly includes settings that have customized values (not default values).", "nullable": true, "items": { "$ref": "#/components/schemas/CustomizedSettingsModel" } } } }, "AdvisorRecommendationResponseModelCollection": { "title": "AdvisorRecommendationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAdvisorRecommendationResponseModel" }, { "type": "object", "description": "The list of advisor recommendations.", "additionalProperties": false, "properties": { "JobsInProgress": { "title": "RefResponseModel[]", "type": "array", "description": "List of jobs currently in progress.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } } } } ] }, "AdvisorSettingsResponseModel": { "title": "AdvisorSettingsResponseModel", "type": "object", "description": "Advisor settings response model.", "additionalProperties": false, "properties": { "DismissedRecommendations": { "title": "String[]", "type": "array", "description": "The dismissed recommendations.", "nullable": true, "items": { "title": "String", "type": "string" } }, "DismissedResources": { "title": "DismissedResource[]", "type": "array", "description": "The resources the recommendations are dismissed for.", "nullable": true, "items": { "$ref": "#/components/schemas/DismissedResource" } }, "Settings": { "title": "CustomizedSettingsModel[]", "type": "array", "description": "All settings with their customized values and metadata.", "nullable": true, "items": { "$ref": "#/components/schemas/CustomizedSettingsModel" } } } }, "AllocationType": { "title": "AllocationType", "type": "string", "description": "Machine allocation type, indicating how machines are allocated to users.", "x-enumNames": [ "Unknown", "Static", "Random" ], "enum": [ "Unknown", "Static", "Random" ] }, "AllowedConnection": { "title": "AllowedConnection", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Filtered", "NotViaAG", "ViaAG", "AnyViaAG" ], "enum": [ "Unknown", "Filtered", "NotViaAG", "ViaAG", "AnyViaAG" ] }, "AllowedUser": { "title": "AllowedUser", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Filtered", "AnyAuthenticated", "Any", "AnonymousOnly", "FilteredOrAnonymous" ], "enum": [ "Unknown", "Filtered", "AnyAuthenticated", "Any", "AnonymousOnly", "FilteredOrAnonymous" ] }, "AllResponseContract": { "title": "AllResponseContract", "type": "object", "description": "ALL: Policy, Template, Setting Definitions and Filter Definitions", "additionalProperties": false, "properties": { "Policies": { "title": "IEnumerable`1", "type": "array", "description": "Policies", "nullable": true, "items": { "$ref": "#/components/schemas/PolicyResponseContract" } }, "Templates": { "title": "IEnumerable`1", "type": "array", "description": "Templates", "nullable": true, "items": { "$ref": "#/components/schemas/TemplateResponseContract" } }, "SettingDefinitions": { "title": "IEnumerable`1", "type": "array", "description": "Setting Definitions", "nullable": true, "items": { "$ref": "#/components/schemas/SettingDefinitionContract" } }, "FilterDefinitions": { "title": "IEnumerable`1", "type": "array", "description": "Filter Definitions", "nullable": true, "items": { "$ref": "#/components/schemas/FilterDefinitionContract" } } } }, "AotSettingResponseModel": { "title": "AotSettingResponseModel", "type": "object", "additionalProperties": false, "properties": { "Server": { "title": "String", "type": "string", "description": "The log server name.", "nullable": true }, "Port": { "title": "Int32", "type": "integer", "description": "The log server port. ", "format": "int32" }, "EnabledOnDeliveryController": { "title": "Boolean", "type": "boolean", "description": "The AOT is enabled on delivery controller" }, "EnabledOnAllDeliveryGroups": { "title": "Boolean", "type": "boolean", "description": "The AOT is enabled on all delivery groups" }, "EnabledOnDeliveryGroups": { "title": "RefResponseModel[]", "type": "array", "description": "The delivery groups on which AOT is enabled", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "LogServerResourceLocationId": { "title": "String", "type": "string", "description": "The resource location where the log server locate.", "nullable": true }, "LogServerApiKey": { "title": "String", "type": "string", "description": "The API key to access the log server.", "nullable": true } } }, "AppAccessPolicyRequestModel": { "title": "AppAccessPolicyRequestModel", "type": "object", "description": "Request object for the app access rules attached to a delivery group.\nWhen the delivery group type=AppsOnly and SharingKind=Private,\nthis turns into New-BrokerAppAssignmentPolicyRule.\nWhen type=(AppsOnly or DesktopsAndApps) and SharingKind=Shared,\nthis turns into New-BrokerAppEntitlementPolicyRule.\nWhen type=DesktopsOnly and SharingKind=Private, it is not allowed to\nspecify this policy.\nThe combination of type=AppsAndDesktops and SharingKind=Private is\nalso not allowed.", "additionalProperties": false, "properties": { "Enabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the app access policy is enabled.", "nullable": true }, "ExcludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the ExcludedUsers filter\nis enabled. If the filter is disabled then any user entries in\nthe filter are ignored when determining which applications are\navailable for a user.", "nullable": true }, "ExcludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the excluded users filter for applications\npublished on the delivery group; that is,\nthe users and groups who are explicitly denied access to\nALL applications published on the delivery group.", "nullable": true, "example": [ "Name of an excluded user" ], "items": { "title": "String", "type": "string" } }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery group's access\npolicy may access applications published on the delivery\ngroup.", "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the included users filter for applications\npublished on the delivery group; that is, the users and\ngroups who are explicitly granted access to applications\npublished on the delivery group.", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } }, "LeasingBehavior": { "description": "Defines the desired connection leasing behavior applied to\napplication sessions.", "nullable": true, "$ref": "#/components/schemas/LeasingBehavior" }, "SessionReconnection": { "description": "Defines reconnection (roaming) behavior for sessions\nlaunched to applications associated with the delivery group.", "nullable": true, "$ref": "#/components/schemas/SessionReconnection" } } }, "AppAccessPolicyResponseModel": { "title": "AppAccessPolicyResponseModel", "type": "object", "description": "Response object for application access policy.", "additionalProperties": false, "required": [ "ExcludedUserFilterEnabled", "IncludedUserFilterEnabled" ], "properties": { "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this policy is enabled." }, "ExcludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the ExcludedUsers filter\nis enabled. If the filter is disabled then any user entries in\nthe filter are ignored when determining which applications are\navailable for a user." }, "ExcludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The excluded users filter for applications\npublished on the delivery group; that is,\nthe users and groups who are explicitly denied access to\nALL applications published on the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery group's access\npolicy may access applications published on the delivery\ngroup." }, "IncludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The included users filter for applications\npublished on the delivery group; that is, the users and\ngroups who are explicitly granted access to applications\npublished on the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "LeasingBehavior": { "description": "Indicates the connection leasing behavior applied to\napplication sessions.", "nullable": true, "$ref": "#/components/schemas/LeasingBehavior" }, "SessionReconnection": { "description": "Indicates reconnection (roaming) behavior for sessions\nlaunched to applications associated with the delivery group.", "nullable": true, "$ref": "#/components/schemas/SessionReconnection" } } }, "AppGroupCompatibility": { "title": "AppGroupCompatibility", "type": "string", "description": "App Group Compatibility set.\n ", "x-enumNames": [ "Unknown", "Compatible", "IncompatiblePrivate", "IncompatibleDeliveryType" ], "enum": [ "Unknown", "Compatible", "IncompatiblePrivate", "IncompatibleDeliveryType" ] }, "AppLibPackageDiscoveryProfileRequestModel": { "title": "AppLibPackageDiscoveryProfileRequestModel", "type": "object", "description": "Request model to create an AppLib Package Discovery Profile.", "additionalProperties": false, "required": [ "DiscoveryType", "Name", "DesktopGroupUid" ], "properties": { "DiscoveryType": { "description": "Gets or sets the name of the package discovery profile", "$ref": "#/components/schemas/AppLibPackageDiscoveryType" }, "Name": { "title": "String", "type": "string", "description": "The name of the package discovery profile", "minLength": 1 }, "DesktopGroupUid": { "title": "Int32", "type": "integer", "description": "The UID of the DesktopGroup from which the broker will select a VDA to run the discovery.", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 }, "Path": { "title": "String", "type": "string", "description": "The root directory where the discovery will run", "maxLength": 250, "nullable": true }, "Recurse": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search the child directory tree.", "default": true, "nullable": true }, "ManagementServer": { "title": "String", "type": "string", "description": "The url of the App-V Management server that packages will be discovered from.", "maxLength": 250, "nullable": true }, "PublishingServer": { "title": "String", "type": "string", "description": "The url of the App-V Publishing server that packages will be discovered from.", "maxLength": 250, "nullable": true }, "Username": { "title": "String", "type": "string", "description": "The username of the App-V Server Administrator.", "nullable": true }, "Password": { "title": "String", "type": "string", "description": "The password of the App-V Server Administrator.", "nullable": true }, "PasswordFormat": { "description": "Format of the Password. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "DiscoverAppV": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover App-V Packages.", "default": true, "nullable": true }, "DiscoverMsix": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover MSIX Packages.", "default": false, "nullable": true }, "DiscoverAppAttach": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover AppAttach Packages.", "default": false, "nullable": true }, "DiscoverFlexApp": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover FlexApp Packages.", "default": false, "nullable": true }, "DiscoverElasticAppLayers": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover ElasticAppLayers Packages.", "default": false, "nullable": true }, "DiscoverCloudpaging": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover Cloudpaging Packages.", "default": false, "nullable": true }, "AutomateDiscovery": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether the discovery should run automatically.", "default": false, "nullable": true }, "AutoDiscoveryPeriod": { "description": "A value indicating what time period should use to trigger the discovery.", "default": "None", "nullable": true, "$ref": "#/components/schemas/AutoDiscoveryPeriod" }, "AutoDiscoveryCadence": { "title": "Int32", "type": "integer", "description": "A value indicating how often to trigger the discovery.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0 }, "CleanupAbsentPackages": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to clean up absent packages.", "default": false, "nullable": true }, "CloudpagerConsoleUrl": { "title": "String", "type": "string", "description": "The URL of the Cloudpager Console.", "nullable": true }, "CloudpagerSubscriptionKey": { "title": "String", "type": "string", "description": "The Cloudpager Subscription Key.", "nullable": true }, "CloudpagerMsid": { "title": "String", "type": "string", "description": "The Cloudpager msid.", "nullable": true }, "IgnoreDowngrade": { "title": "Boolean", "type": "boolean", "description": "If ignore downgrade.", "nullable": true }, "InplaceUpgrade": { "title": "Boolean", "type": "boolean", "description": "If inplace upgrade.", "nullable": true } } }, "AppLibPackageDiscoveryProfileResponseModel": { "title": "AppLibPackageDiscoveryProfileResponseModel", "type": "object", "description": "PackageDiscoveryProfile response model.", "additionalProperties": false, "properties": { "Uid": { "title": "Int32", "type": "integer", "description": "Gets or sets a unique persistent identifier for the PackageDiscoveryProfile.", "format": "int32", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name for the PackageDiscoveryProfile.", "nullable": true }, "DesktopGroupUid": { "title": "Int32", "type": "integer", "description": "The UID of the DesktopGroup from which the broker will select a VDA to run the discovery.", "format": "int32" }, "Path": { "title": "String", "type": "string", "description": "The path to the root directory where the discovery will run.", "nullable": true }, "Recurse": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search the child directory tree." }, "ManagementServer": { "title": "String", "type": "string", "description": "The url of the App-V Management server that packages will be discovered from.", "nullable": true }, "PublishingServer": { "title": "String", "type": "string", "description": "The url of the App-V Publishing server that packages will be discovered from.", "nullable": true }, "Username": { "title": "String", "type": "string", "description": "The username of the App-V server administrator.", "nullable": true }, "DiscoverAppV": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover App-V Packages." }, "DiscoverMsix": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover Msix Packages." }, "DiscoverAppAttach": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover AppAttach Packages." }, "DiscoverFlexApp": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover FlexApp Packages." }, "DiscoverElasticAppLayers": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover ElasticApp Layers Packages." }, "DiscoverCloudpaging": { "title": "Boolean", "type": "boolean", "description": "a value indicating whether to search should Discover Cloudpaging Packages." }, "AutomateDiscovery": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether the discovery should run automatically." }, "AutoDiscoveryPeriod": { "title": "String", "type": "string", "description": "A value indicating what time period should use to trigger the discovery.", "nullable": true }, "AutoDiscoveryCadence": { "title": "Int32", "type": "integer", "description": "A value indicating how often to trigger the discovery.", "format": "int32" }, "CleanupAbsentPackages": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether clean up absent packages." }, "CloudpagerConsoleUrl": { "title": "String", "type": "string", "description": "The URL of the Cloudpager Console.", "nullable": true }, "CloudpagerSubscriptionKey": { "title": "String", "type": "string", "description": "The Cloudpager Subscription Key.", "nullable": true }, "CloudpagerMsid": { "title": "String", "type": "string", "description": "The Cloudpager msid.", "nullable": true }, "IgnoreDowngrade": { "title": "Boolean", "type": "boolean", "description": "If ignore downgrade.", "nullable": true }, "InplaceUpgrade": { "title": "Boolean", "type": "boolean", "description": "If inplace upgrade.", "nullable": true } } }, "AppLibPackageDiscoveryProfileResponseModelCollection": { "title": "AppLibPackageDiscoveryProfileResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAppLibPackageDiscoveryProfileResponseModel" }, { "type": "object", "description": "Advanced access policy response model collection", "additionalProperties": false } ] }, "AppLibPackageDiscoveryRequestModel": { "title": "AppLibPackageDiscoveryRequestModel", "type": "object", "description": "Request model to create an AppLib Package Discovery Session.", "additionalProperties": false, "properties": { "DiscoveryType": { "description": "Gets or sets the name of the package discovery type", "nullable": true, "$ref": "#/components/schemas/AppLibPackageDiscoveryType" }, "DiscoveryProfileUid": { "title": "Int32", "type": "integer", "description": "the UID of AppLib package discovery profile", "format": "int32", "nullable": true }, "DesktopGroupUid": { "title": "Int32", "type": "integer", "description": "The UID of the DesktopGroup from which the broker will select a VDA to run the discover session.", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0, "nullable": true }, "Path": { "title": "String", "type": "string", "description": "The root directory where the discovery session will run.", "maxLength": 250, "nullable": true }, "Recurse": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search the child directory tree.", "default": true, "nullable": true }, "DiscoverAppV": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to discover App-V packages", "default": false, "nullable": true }, "DiscoverMsiX": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to discover MSIX packages", "default": false, "nullable": true }, "DiscoverAppAttach": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to discover AppAttach packages", "default": false, "nullable": true }, "DiscoverFlexApp": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to discover FlexApp packages", "default": false, "nullable": true }, "DiscoverElasticAppLayers": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to discover ElasticApp layers packages", "default": false, "nullable": true }, "DiscoverCloudpaging": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover Cloudpaging Packages.", "default": false, "nullable": true }, "ManagementServer": { "title": "String", "type": "string", "description": "The url of the App-V Management Server that packages will be discovered from.", "maxLength": 250, "nullable": true }, "PublishingServer": { "title": "String", "type": "string", "description": "A value indicating whether to discover AppAttach packages", "maxLength": 250, "nullable": true }, "Username": { "title": "String", "type": "string", "description": "the username of App-V server admin", "nullable": true }, "Password": { "title": "String", "type": "string", "description": "the password of App-V server admin", "nullable": true }, "PasswordFormat": { "description": "Format of the Password. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "CleanupAbsentPackages": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to clean up absent packages", "default": false, "nullable": true }, "CloudpagerConsoleUrl": { "title": "String", "type": "string", "description": "The URL of the Cloudpager Console.", "nullable": true }, "CloudpagerSubscriptionKey": { "title": "String", "type": "string", "description": "The Cloudpager Subscription Key.", "nullable": true }, "CloudpagerMsid": { "title": "String", "type": "string", "description": "The Cloudpager msid.", "nullable": true }, "IgnoreDowngrade": { "title": "Boolean", "type": "boolean", "description": "If ignore downgrade.", "nullable": true }, "InplaceUpgrade": { "title": "Boolean", "type": "boolean", "description": "If inplace upgrade.", "nullable": true } } }, "AppLibPackageDiscoveryResponseModel": { "title": "AppLibPackageDiscoveryResponseModel", "type": "object", "description": "AppLib Package Discovery Response model.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Get or set a unique persistent identifier for the PackageDiscoverySession.", "nullable": true }, "DiscoveryProfileUid": { "title": "Int32", "type": "integer", "description": "Get or set a unique persistent identifier for the PackageDiscoveryProfile.", "format": "int32", "nullable": true }, "DesktopGroupUid": { "title": "Int32", "type": "integer", "description": "The UID of the DesktopGroup from which the broker will select a VDA to run the discovery.", "format": "int32" }, "BrokerMachineUid": { "title": "Int32", "type": "integer", "description": "Get or set a unique persistent identifier for the BrokerMachine.", "format": "int32" }, "BrokerMachineSID": { "title": "String", "type": "string", "description": "Gets or sets the SID of the broker machine that was chosen to run the discovery.", "nullable": true }, "Path": { "title": "String", "type": "string", "description": "The path to the root directory where the discovery will run.", "nullable": true }, "ManagementServer": { "title": "String", "type": "string", "description": "The url of the App-V Management server that packages will be discovered from.", "nullable": true }, "PublishingServer": { "title": "String", "type": "string", "description": "The url of the App-V server that packages wil be discovered from.", "nullable": true }, "Status": { "description": "The status of PackageDiscoverySession", "$ref": "#/components/schemas/AppLibPackageDiscoveryStatus" }, "StatusMessage": { "title": "String", "type": "string", "description": "The status message of PackageDiscoverySession", "nullable": true }, "ImportedPackages": { "title": "Int32", "type": "integer", "description": "the number of the imported packages", "format": "int32" }, "ImportProgress": { "title": "Int32", "type": "integer", "description": "the progress of package import", "format": "int32" }, "DiscoveredPackages": { "title": "Int32", "type": "integer", "description": "the number of discovered packages", "format": "int32" }, "DiscoveryProgress": { "title": "Int32", "type": "integer", "description": "the progress of the package discovery", "format": "int32" }, "ExpectedPackages": { "title": "Int32", "type": "integer", "description": "the number of the expected packages", "format": "int32" }, "ReportingProgress": { "title": "Int32", "type": "integer", "description": "Gets the percentage value of the reporting progress.", "format": "int32" }, "ReportedPackages": { "title": "Int32", "type": "integer", "description": "Gets or sets the number of packages that have reported so far.\n ", "format": "int32" }, "DiscoverAppAttach": { "title": "Boolean", "type": "boolean", "description": "If it is a discover app attach packages." }, "DiscoverAppV": { "title": "Boolean", "type": "boolean", "description": "If it is discover App-V packages." }, "DiscoverElasticAppLayers": { "title": "Boolean", "type": "boolean", "description": "If it is a discover Elastic App Layers." }, "DiscoverFlexApp": { "title": "Boolean", "type": "boolean", "description": "If it is discover FlexApp packages." }, "DiscoverMsix": { "title": "Boolean", "type": "boolean", "description": "If it is discover MSIX packages." }, "DiscoverCloudpaging": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover Cloudpaging Packages." }, "NewPackages": { "title": "Int32", "type": "integer", "description": "New packages number.", "format": "int32" }, "Recurse": { "title": "Boolean", "type": "boolean", "description": "If recurse." }, "RemovedPackages": { "title": "Int32", "type": "integer", "description": "Removed packages number.", "format": "int32" }, "Uid": { "title": "Int32", "type": "integer", "description": "The int type of unique identifier.", "format": "int32" }, "DiscoverySessionTime": { "title": "String", "type": "string", "description": "Get the discovery session time", "nullable": true }, "CloudpagerConsoleUrl": { "title": "String", "type": "string", "description": "The URL of the Cloudpager Console.", "nullable": true }, "CloudpagerSubscriptionKey": { "title": "String", "type": "string", "description": "The Cloudpager Subscription Key.", "nullable": true }, "CloudpagerMsid": { "title": "String", "type": "string", "description": "The Cloudpager msid.", "nullable": true }, "IgnoreDowngrade": { "title": "Boolean", "type": "boolean", "description": "If ignore downgrade." }, "InplaceUpgrade": { "title": "Boolean", "type": "boolean", "description": "If inplace upgrade." } } }, "AppLibPackageDiscoveryResponseModelCollection": { "title": "AppLibPackageDiscoveryResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAppLibPackageDiscoveryResponseModel" }, { "type": "object", "description": "Package discovery session response model collection", "additionalProperties": false } ] }, "AppLibPackageDiscoveryStatus": { "title": "AppLibPackageDiscoveryStatus", "type": "string", "description": "Enum to indicate the status of the package discovery process", "x-enumNames": [ "Unknown", "Pending", "Failed", "Discovering", "FinishedWithDataWaiting", "Reporting", "Importing", "Finished" ], "enum": [ "Unknown", "Pending", "Failed", "Discovering", "FinishedWithDataWaiting", "Reporting", "Importing", "Finished" ] }, "AppLibPackageDiscoveryType": { "title": "AppLibPackageDiscoveryType", "type": "string", "description": "AppLibPackageDiscoveryType enumeration defines the type of discovery for AppLib packages.", "x-enumNames": [ "Unknown", "NetworkShareDiscovery", "AppVServerDiscovery", "CloudpagerDiscovery" ], "enum": [ "Unknown", "NetworkShareDiscovery", "AppVServerDiscovery", "CloudpagerDiscovery" ] }, "ApplicationDeliveryGroupResponseModel": { "title": "ApplicationDeliveryGroupResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,Delivering,DeliveryType,Description,DesktopsDisconnected,DesktopsUnregistered,Enabled,InMaintenanceMode,IsRemotePC,MachineLogOnType,MinimumFunctionalLevel,Name,FullName,PublishedName,SessionSupport,SharingKind,DefaultDesktopIconId. \n Prioritized delivery group model.\n ", "allOf": [ { "$ref": "#/components/schemas/DeliveryGroupResponseModel" }, { "type": "object", "description": "Prioritized delivery group model.", "additionalProperties": false, "required": [ "Priority" ], "properties": { "Priority": { "title": "Int32", "type": "integer", "description": "Specifies the priority of the mapping between application and delivery\ngroup where lower numbers imply higher priority with zero being highest.", "format": "int32" } } } ] }, "ApplicationDeliveryGroupResponseModelCollection": { "title": "ApplicationDeliveryGroupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfApplicationDeliveryGroupResponseModel" }, { "type": "object", "description": "Collection of ApplicationDeliveryGroupResponseModel ", "additionalProperties": false } ] }, "ApplicationDetailResponseModel": { "title": "ApplicationDetailResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): BrowserName,Categories,ConfiguredFtas,CpuPriorityLevel,HomeZone,HomeZoneMode,IncludedUserFilterEnabled,IconFromClient,IncludedUsers,MaxPerUserInstances,MaxTotalInstances,ShortcutAddedToDesktop,ShortcutAddedToStartMenu,StartMenuFolder,WaitForPrinterCreation,Id,Uid,ApplicationFolder,ApplicationType,PackagedApplicationType,PackagedApplicationVisibility,ClientFolder,Description,DoNotEnumerate,Enabled,IconId,ContentLocation,Name,PublishedName,Visible,SharingKind,ZoneId. \n Response object for application details.\n ", "allOf": [ { "$ref": "#/components/schemas/ApplicationResponseModel" }, { "type": "object", "description": "Response object for application details.", "additionalProperties": false, "required": [ "BrowserName", "CpuPriorityLevel", "HomeZone", "HomeZoneMode", "IncludedUserFilterEnabled" ], "properties": { "BrowserName": { "title": "String", "type": "string", "description": "Internal name of the application.", "minLength": 1 }, "Categories": { "title": "String[]", "type": "array", "description": "Categories in which the application resides.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ConfiguredFtas": { "title": "FtaResponseModel[]", "type": "array", "description": "All file types which are associated with the application.", "nullable": true, "items": { "$ref": "#/components/schemas/FtaResponseModel" } }, "CpuPriorityLevel": { "description": "The CPU priority for the launched process.", "$ref": "#/components/schemas/CpuPriorityLevel" }, "HomeZone": { "description": "Home zone preference used when launching this\napplication.", "$ref": "#/components/schemas/RefResponseModel" }, "HomeZoneMode": { "description": "The zone preference mode for application launches.", "$ref": "#/components/schemas/HomeZoneMode" }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery group's access\npolic(ies) is implicitly granted access to the application." }, "IconFromClient": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the icon is gotten from user's computer at run time.\nIf not specified, will not be changed.", "nullable": true }, "IncludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The included users filter of the application; that is,\nthe users and groups who are explicitly granted access to the\npublished application.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "MaxPerUserInstances": { "title": "Int32", "type": "integer", "description": "The maximum allowed concurrently running instances of\nthe application that an individual user can have.", "format": "int32", "nullable": true }, "MaxTotalInstances": { "title": "Int32", "type": "integer", "description": "The maximum allowed total of concurrently running\ninstances of the application within the site.", "format": "int32", "nullable": true }, "ShortcutAddedToDesktop": { "title": "Boolean", "type": "boolean", "description": "Indicates whether a shortcut to the application\nshould be placed on the user device.", "nullable": true }, "ShortcutAddedToStartMenu": { "title": "Boolean", "type": "boolean", "description": "Indicates whether a shortcut to the application\nshould be placed in the user's start menu on their user device.", "nullable": true }, "StartMenuFolder": { "title": "String", "type": "string", "description": "Name of the start menu folder that holds\nthe application shortcut (if any).", "nullable": true }, "WaitForPrinterCreation": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the session waits for the printers to\nbe created before allowing the user to interact with the session.", "nullable": true }, "ZoneList": { "title": "String[]", "type": "array", "description": "A list of zones that the application may launch.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "ApplicationDiscoveryItemType": { "title": "ApplicationDiscoveryItemType", "type": "string", "description": "Type to indicate application discovery item type", "x-enumNames": [ "Unknown", "MachineShares", "DirectoryOrFiles", "ApplicationProperty" ], "enum": [ "Unknown", "MachineShares", "DirectoryOrFiles", "ApplicationProperty" ] }, "ApplicationDiscoveryRequestModel": { "title": "ApplicationDiscoveryRequestModel", "type": "object", "description": "Specify ApplicationGroups, DeliverGroups or MachineCatalogs to find the best machine to browse application;\nOr specify machine IP/DnsName to browse application from the machine.\nIf both ApplicationGroups, DeliveryGroups, MachineCatalogs and ServerOrPath are specified, ServerOrPath will take priority.", "additionalProperties": false, "properties": { "ApplicationGroups": { "title": "String[]", "type": "array", "description": "The machines associated with Application Groups will be browsed.", "nullable": true, "example": [ "Name or Id of an application group" ], "items": { "title": "String", "type": "string" } }, "DeliveryGroups": { "title": "String[]", "type": "array", "description": "The machines associated with Delivery Groups will be browsed.", "nullable": true, "example": [ "Name or Id of a delivery group" ], "items": { "title": "String", "type": "string" } }, "MachineCatalogs": { "title": "String[]", "type": "array", "description": "The machines in the catalogs will be browsed.", "nullable": true, "example": [ "Name or Id of a catalog" ], "items": { "title": "String", "type": "string" } }, "ServerOrPath": { "title": "String", "type": "string", "description": "Specify machine IP or DNS to get machine shares;\nSpecify local path to get directory/files.", "nullable": true, "example": "serverName: \"MYSERVER\"; machine share: \"\\\\MYSERVER\\c$\"; path: \\\\MYSERVER\\c$\\Program Files" } } }, "ApplicationDiscoveryResponseModel": { "title": "ApplicationDiscoveryResponseModel", "type": "object", "description": "Response object for application discovery.", "additionalProperties": false, "properties": { "item": { "title": "String", "type": "string", "description": "Serialized string that is a list of machine shares,\nor a list of directories, or application properties that parsed from a selected executable file.", "nullable": true }, "type": { "description": "Indicating the item type", "$ref": "#/components/schemas/ApplicationDiscoveryItemType" } } }, "ApplicationFolderResponseModel": { "title": "ApplicationFolderResponseModel", "type": "object", "description": "Response object for an application folder.", "additionalProperties": false, "required": [ "Id", "Children", "Name", "Path", "TotalApplications" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the application folder.\nUsed to be: Uuid\nNeeds to be globally unique\nThis is likely to contain a guid but the property type should be string for future flexibility", "minLength": 1 }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED. Use .` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use .", "nullable": true }, "Children": { "title": "RefResponseModel[]", "type": "array", "description": "Child folders.", "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "Name": { "title": "String", "type": "string", "description": "Name of the folder.", "minLength": 1 }, "Parent": { "description": "Parent folder.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "Path": { "title": "String", "type": "string", "description": "Full path to the folder.\nUsed to be: FullName", "minLength": 1 }, "TotalApplications": { "title": "Int32", "type": "integer", "description": "Total number of applications in the folder.", "format": "int32" }, "TotalMachineCatalogs": { "title": "Int32", "type": "integer", "description": "Total number of machine catalogs in the folder.", "format": "int32" }, "TotalDesktopGroups": { "title": "Int32", "type": "integer", "description": "Total number of delivery groups in the folder.", "format": "int32" }, "TotalApplicationGroups": { "title": "Int32", "type": "integer", "description": "Total number of application groups in the folder.", "format": "int32" } } }, "ApplicationFolderResponseModelCollection": { "title": "ApplicationFolderResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfApplicationFolderResponseModel" }, { "type": "object", "description": "The collection for ApplicationFolderResponseModel", "additionalProperties": false } ] }, "ApplicationGroupAddApplicationsRequestModel": { "title": "ApplicationGroupAddApplicationsRequestModel", "type": "object", "description": "The request model for adding apps to app group.\n ", "additionalProperties": false, "properties": { "ExistingApplications": { "title": "String[]", "type": "array", "description": "List of existing applications to be associated with the\napplication group.\n\nOptional. Default is not to create any new associations of\nexisting applications to the application group.\n\n\nEach item can be specified by \nor .\n \nAll applications associated with a application group must\nSharingKind equal to\nShared.", "nullable": true, "example": [ "Name of an application" ], "items": { "title": "String", "type": "string" } }, "NewApplications": { "title": "CreateApplicationRequestModel[]", "type": "array", "description": "List of applications which should be created and associated\nwith the application group.\nOptional. Default is not to create any new applications\nassociated with the application group.", "nullable": true, "items": { "$ref": "#/components/schemas/CreateApplicationRequestModel" } } } }, "ApplicationGroupDeliveryGroupRefResponseModel": { "title": "ApplicationGroupDeliveryGroupRefResponseModel", "allOf": [ { "$ref": "#/components/schemas/RefResponseModel" }, { "type": "object", "description": "Prioritized delivery group reference model.", "additionalProperties": false, "properties": { "Priority": { "title": "Int32", "type": "integer", "description": "Specifies the priority of the mapping between application and delivery\ngroup where lower numbers imply higher priority with zero being highest.", "format": "int32" }, "NumMachines": { "title": "Int32", "type": "integer", "description": "Number of machines within the delivery group that are capable of hosting the\napplications in the application group.", "format": "int32" }, "NumTaggedMachines": { "title": "Int32", "type": "integer", "description": "Number of tagged machines within the delivery group that are capable of hosting the\napplications in the application group.", "format": "int32" }, "SessionSupport": { "description": "Type of session support provided by machines in the delivery group.", "$ref": "#/components/schemas/SessionSupport" } } } ] }, "ApplicationGroupDeliveryGroupResponseModel": { "title": "ApplicationGroupDeliveryGroupResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,Delivering,DeliveryType,Description,DesktopsDisconnected,DesktopsUnregistered,Enabled,InMaintenanceMode,IsRemotePC,MachineLogOnType,MinimumFunctionalLevel,Name,FullName,PublishedName,SessionSupport,SharingKind,DefaultDesktopIconId. \n Prioritized delivery group model.\n ", "allOf": [ { "$ref": "#/components/schemas/DeliveryGroupResponseModel" }, { "type": "object", "description": "Prioritized delivery group model.", "additionalProperties": false, "required": [ "Priority", "NumMachines" ], "properties": { "Priority": { "title": "Int32", "type": "integer", "description": "Specifies the priority of the mapping between application and delivery\ngroup where lower numbers imply higher priority with zero being highest.", "format": "int32" }, "NumMachines": { "title": "Int32", "type": "integer", "description": "Number of machines within the delivery group that are capable of hosting the\napplications in the application group.", "format": "int32" } } } ] }, "ApplicationGroupDeliveryGroupResponseModelCollection": { "title": "ApplicationGroupDeliveryGroupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfApplicationGroupDeliveryGroupResponseModel" }, { "type": "object", "description": "Collection of ApplicationDeliveryGroupResponseModel ", "additionalProperties": false } ] }, "ApplicationGroupDetailResponseModel": { "title": "ApplicationGroupDetailResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,Description,Enabled,Name,FullName,AdminFolder. \n Detailed response object for application groups.\n ", "allOf": [ { "$ref": "#/components/schemas/ApplicationGroupResponseModel" }, { "type": "object", "description": "Detailed response object for application groups.", "additionalProperties": false, "required": [ "ApplicationCount", "IncludedUsersFilterEnabled", "SessionSharingEnabled", "TotalMachines" ], "properties": { "ApplicationCount": { "title": "Int32", "type": "integer", "description": "Number of applications in the group.", "format": "int32" }, "IncludedUsersFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery group's access\npolic(ies) is implicitly granted access to the applications\nin the application group." }, "IncludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The included users filter of the application group; that is,\nthe users and groups who are explicitly granted access to the\napplications in the application group.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "SessionSharingEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether applications in this application group can share\nsessions with applications in other application groups\n(or with applications that are not a member of an\napplication group)." }, "TotalMachines": { "title": "Int32", "type": "integer", "description": "Total number of machines across all delivery groups on\nwhich the application group is published.", "format": "int32" } } } ] }, "ApplicationGroupNameCheckRequestModel": { "title": "ApplicationGroupNameCheckRequestModel", "type": "object", "description": "Model for Checking Application Group Name with Admin Folder", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Application Group Name with Admin Folder", "nullable": true } } }, "ApplicationGroupResponseModel": { "title": "ApplicationGroupResponseModel", "type": "object", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,Description,Enabled,Name,FullName,AdminFolder. \n Response object for an application group.\n ", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the application group.\nUsed to be: Uuid\nNeeds to be globally unique\nThis is likely to contain a guid but the property type should be string for future flexibility", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED. Use .` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use .", "nullable": true }, "ContainerScopes": { "title": "ContainerScopeResponseModel[]", "type": "array", "description": "Delegated admin scopes in which the containers of the\napplication group reside.", "nullable": true, "items": { "$ref": "#/components/schemas/ContainerScopeResponseModel" } }, "Description": { "title": "String", "type": "string", "description": "Description of the application group.\nAs with other facets of application groups, the\ndescription is not visible to end users.", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether or not the applications in this\napplication group can be launched." }, "Name": { "title": "String", "type": "string", "description": "Simple administrative name of application group\nwithin parent admin folder (if any). This property\nis not guaranteed unique across all application groups.", "nullable": true }, "FullName": { "title": "String", "type": "string", "description": "Name of this application group. The name uniquely\nidentifies the application group within the site.\nAs with other facets of application groups, the\nname is not visible to end users.", "nullable": true }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "The list of the delegated admin scopes to which\nthe application group belongs.", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of application group.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Tags": { "title": "String[]", "type": "array", "description": "Tags associated with this application group.", "nullable": true, "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "RefResponseModel[]", "type": "array", "description": "The tenant(s) that the application group is assigned to. If `null`,\nthe application group is not assigned to tenants, and may be used by\nany tenant, including future added tenants.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "NumApplications": { "title": "Int32", "type": "integer", "description": "Number of applications present in the application group.", "format": "int32" }, "NumMachines": { "title": "Int32", "type": "integer", "description": "Number of machines capable of hosting the applications in the application group.", "format": "int32" }, "NumMachinesWithTag": { "title": "Int32", "type": "integer", "description": "Total number of machines across all desktop groups on\nwhich the application group is published,\nand which are tagged with the tag given by the RestrictToTag property.", "format": "int32" }, "RestrictToTag": { "description": "Optional tag that may be used further to restrict which\napplication groups may be made accessible to a user.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "DeliveryGroups": { "title": "ApplicationGroupDeliveryGroupRefResponseModel[]", "type": "array", "description": "Delivery groups associated with the application group.", "nullable": true, "items": { "$ref": "#/components/schemas/ApplicationGroupDeliveryGroupRefResponseModel" } }, "AssociatedDeliveryGroupUids": { "title": "Int32[]", "type": "array", "description": "Delivery group uids associated with the application group.", "nullable": true, "items": { "title": "Int32", "type": "integer", "format": "int32" } }, "AdminFolder": { "description": "The folder in which the application group resides.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" } } }, "ApplicationGroupResponseModelCollection": { "title": "ApplicationGroupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfApplicationGroupResponseModel" }, { "type": "object", "description": "Application group response model collection", "additionalProperties": false } ] }, "ApplicationGroupSearchRequestModel": { "title": "ApplicationGroupSearchRequestModel", "allOf": [ { "$ref": "#/components/schemas/ApplicationSearchRequestModel" }, { "type": "object", "description": "Request model for defining advanced application search criteria.", "additionalProperties": false, "properties": { "ApplicationGroupFolder": { "title": "String", "type": "string", "description": "Application group folder in which to search for the application group.", "nullable": true, "example": "Name of an application group folder" } } } ] }, "ApplicationResponseModel": { "title": "ApplicationResponseModel", "type": "object", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,ApplicationFolder,ApplicationType,PackagedApplicationType,PackagedApplicationVisibility,ClientFolder,Description,DoNotEnumerate,Enabled,IconId,ContentLocation,Name,PublishedName,Visible,SharingKind,ZoneId. \n Response object for application.\n ", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "The id of the application.\nUsed to be: Uuid\nNeeds to be globally unique\nThis is likely to contain a guid but the property type should be string for future flexibility", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED. Use .` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use .", "nullable": true }, "ApplicationFolder": { "description": "The folder in which the application resides.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "ApplicationType": { "description": "Type of the application.\nNote: in the past, this was returned as HostedOnDesktop when the\ncaller was working with an App-V or another type of packaged app.\nWe now distinguish explicitly with a \"PackagedApplication\" here\nand a PackagedApplicationType defined below.\nIn the unlikely event that an app is found in the low-level SDK\nwith type SessionPrelauncher, it should be filtered out of the\nREST API response.", "$ref": "#/components/schemas/ApplicationType" }, "PackagedApplicationType": { "description": "The technology used to package the application", "$ref": "#/components/schemas/PackagedApplicationType" }, "PackagedApplicationVisibility": { "description": "The resources (Workspace and/or Desktop session) where packaged application will be visible", "$ref": "#/components/schemas/PackagedApplicationVisibility" }, "ClientFolder": { "title": "String", "type": "string", "description": "The folder that the application belongs to as the user sees it.", "nullable": true }, "ContainerScopes": { "title": "ContainerScopeResponseModel[]", "type": "array", "description": "Delegated admin scopes in which the containers of the\napplication reside.", "nullable": true, "items": { "$ref": "#/components/schemas/ContainerScopeResponseModel" } }, "Description": { "title": "String", "type": "string", "description": "The description of the application.", "nullable": true }, "DoNotEnumerate": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this application is enumerable" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this application can be launched." }, "IconId": { "title": "String", "type": "string", "description": "The id of the icon used for the application.\nUsed to be: IconUid (and it was not globally unique)\nNeeds to be globally unique\nMight be constructed from site ID + internal Uid", "nullable": true }, "InstalledAppProperties": { "description": "Properties of applications that are installed on servers\nor clients.", "nullable": true, "$ref": "#/components/schemas/InstalledAppResponseModel" }, "PackagedAppProperties": { "description": "Properties of applications that are delivered via App Packages.", "nullable": true, "$ref": "#/components/schemas/AppVAppResponseModel" }, "AppVAppProperties": { "description": "Properties of applications that are delivered via App-V.\nAPPV-609: to Maintain backwards compatibility with Studio we need to translate back to the old App-V centric naming.", "nullable": true, "$ref": "#/components/schemas/AppVAppResponseModel" }, "ContentLocation": { "title": "String", "type": "string", "description": "Location of published content.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the application. Only seen by administrators.", "nullable": true }, "PublishedName": { "title": "String", "type": "string", "description": "The name seen by end users who have access to the application.", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of application.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Visible": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this application is visible to users." }, "SharingKind": { "description": "Indicates whether machines hosting the application are shared.", "$ref": "#/components/schemas/SharingKind" }, "Tags": { "title": "String[]", "type": "array", "description": "Tags associated with this application.", "nullable": true, "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "RefResponseModel[]", "type": "array", "description": "The tenant(s) that the application is assigned to. If `null`, the\napplication is not assigned to any tenants, and may be used by any\ntenant.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "CloudWorkspaceManaged": { "title": "Boolean", "type": "boolean", "description": "Indicates whether users are managed in the Citrix Cloud Library, or\nwithin Studio." }, "NumAssociatedDeliveryGroups": { "title": "Int32", "type": "integer", "description": "Number of delivery groups that the application is associated with.", "format": "int32" }, "NumAssociatedApplicationGroups": { "title": "Int32", "type": "integer", "description": "Number of application groups that the application is associated with.", "format": "int32" }, "AssociatedDeliveryGroupUuids": { "title": "String[]", "type": "array", "description": "Delivery group Uuids that the application is associated with.", "nullable": true, "items": { "title": "String", "type": "string" } }, "AssociatedApplicationGroupUuids": { "title": "String[]", "type": "array", "description": "Application group Uuids that the application is associated with.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ZoneId": { "title": "String", "type": "string", "description": "Application Zone info.", "nullable": true } } }, "ApplicationResponseModelCollection": { "title": "ApplicationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfApplicationResponseModel" }, { "type": "object", "description": "Application response model collection", "additionalProperties": false } ] }, "ApplicationSearchRequestModel": { "title": "ApplicationSearchRequestModel", "type": "object", "description": "Request model for defining advanced application search criteria.", "additionalProperties": false, "properties": { "ApplicationFolder": { "title": "String", "type": "string", "description": "Application folder in which to search for the application.", "nullable": true, "example": "Name of an application folder" }, "IncludeSubFolders": { "title": "Boolean", "type": "boolean", "description": "Whether to include subfolders of the\nApplicationFolder in the search for the\napplication.", "default": true, "nullable": true }, "ApplicationGroup": { "title": "String", "type": "string", "description": "Application group in which to search for the application.", "nullable": true, "example": "Name of an application group" }, "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within the application name.", "nullable": true, "example": "For example, name of an application" }, "SearchFilters": { "title": "AppSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/AppSearchFilterRequestModel" } }, "SortCriteria": { "description": "Sort criteria for the results.", "nullable": true, "$ref": "#/components/schemas/AppSortCriteriaRequestModel" }, "SearchFilterGroups": { "title": "AppSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/AppSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/AppSearchFilterGroupsType" } } }, "ApplicationType": { "title": "ApplicationType", "type": "string", "description": "Application Type.", "x-enumNames": [ "Unknown", "HostedOnDesktop", "InstalledOnClient", "SessionPreLauncher", "PublishedContent", "PackagedApplication", "AppV", "AppLibraryAppV", "Msix", "AppAttach", "FlexApp", "ElasticAppLayer", "Cloudpager", "Cloudpaging" ], "enum": [ "Unknown", "HostedOnDesktop", "InstalledOnClient", "SessionPreLauncher", "PublishedContent", "PackagedApplication", "AppV", "AppLibraryAppV", "Msix", "AppAttach", "FlexApp", "ElasticAppLayer", "Cloudpager", "Cloudpaging" ] }, "AppliedPolicy": { "title": "AppliedPolicy", "type": "object", "description": "Information about an applied policy.", "additionalProperties": false, "properties": { "PolicyName": { "title": "String", "type": "string", "description": "Name of the policy.", "nullable": true }, "GpoName": { "title": "String", "type": "string", "description": "Name of the GPO that contains the policy that uses this setting.", "nullable": true }, "Reasons": { "title": "Dictionary`2", "type": "object", "description": "Reasons why the policy is applied.", "nullable": true, "x-dictionaryKey": { "$ref": "#/components/schemas/ReasonStatus" }, "additionalProperties": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/ReasonDetail" } } } } }, "AppliedPolicy2": { "title": "AppliedPolicy", "type": "object", "description": "Policy information.", "additionalProperties": false, "properties": { "IsApplied": { "title": "Boolean", "type": "boolean", "description": "Is policy applied." }, "PolicyName": { "title": "String", "type": "string", "description": "Policy name.", "nullable": true }, "GpoName": { "title": "String", "type": "string", "description": "GPO name.", "nullable": true }, "Reasons": { "title": "Dictionary`2", "type": "object", "description": "Reasons why the policy is or is not applied.", "nullable": true, "additionalProperties": { "title": "String[]", "type": "array", "items": { "title": "String", "type": "string" } } }, "Details": { "title": "Dictionary`2", "type": "object", "description": "Reasons why the policy is or is not applied.", "nullable": true, "additionalProperties": { "title": "FilterDetail[]", "type": "array", "items": { "$ref": "#/components/schemas/FilterDetail" } } } } }, "AppliedSetting": { "title": "AppliedSetting", "type": "object", "description": "Winning setting information.", "additionalProperties": false, "properties": { "SettingName": { "title": "String", "type": "string", "description": "Setting name.", "nullable": true }, "SettingValue": { "title": "String", "type": "string", "description": "Setting value.", "nullable": true }, "PolicyName": { "title": "String", "type": "string", "description": "Name of the policy.", "nullable": true }, "GpoName": { "title": "String", "type": "string", "description": "Name of the GPO that contains the policy that uses this setting.", "nullable": true } } }, "AppliedSetting2": { "title": "AppliedSetting", "type": "object", "description": "Winning setting information.", "additionalProperties": false, "properties": { "SettingName": { "title": "String", "type": "string", "description": "Setting name.", "nullable": true }, "SettingValue": { "title": "String", "type": "string", "description": "Setting value.", "nullable": true }, "WinningGpo": { "title": "String", "type": "string", "description": "Source GPO for the setting.", "nullable": true }, "WinningPolicy": { "title": "String", "type": "string", "description": "Source policy for the setting.", "nullable": true } } }, "AppOrDesktopCompatibility": { "title": "AppOrDesktopCompatibility", "type": "string", "description": "Compatibility set for Apps or Desktops.\n ", "x-enumNames": [ "Unknown", "Compatible", "IncompatibleDeliveryType" ], "enum": [ "Unknown", "Compatible", "IncompatibleDeliveryType" ] }, "AppSearchFilterGroupRequestModel": { "title": "AppSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for applications", "additionalProperties": false, "properties": { "SearchFilterGroupType": { "description": "The type of search filter group", "$ref": "#/components/schemas/AppSearchFilterGroupType" }, "SearchFilters": { "title": "AppSearchFilterRequestModel[]", "type": "array", "description": "The search filters in search filter group", "nullable": true, "items": { "$ref": "#/components/schemas/AppSearchFilterRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/AppSearchFilterGroupsType" }, "SearchFilterGroups": { "title": "AppSearchFilterGroupRequestModel[]", "type": "array", "description": "The search filter group in search filter groups", "nullable": true, "items": { "$ref": "#/components/schemas/AppSearchFilterGroupRequestModel" } } } }, "AppSearchFilterGroupsType": { "title": "AppSearchFilterGroupsType", "type": "string", "description": "The search filter groups type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "AppSearchFilterGroupType": { "title": "AppSearchFilterGroupType", "type": "string", "description": "The search filter group type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "AppSearchFilterRequestModel": { "title": "AppSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for applications.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/AppSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true, "example": "For example, test" }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "AppSearchProperty": { "title": "AppSearchProperty", "type": "string", "description": "Application properties can be used for advanced application searches.\n ", "x-enumNames": [ "Uid", "ClientFolder", "ApplicationGroup", "Name", "Path", "BrowserName", "CommandLineArguments", "DeliveryGroup", "Description", "PublishedName", "Enabled", "MaxTotalInstances", "MaxPerUserInstances", "ShortcutAddedToDesktop", "ShortcutAddedToStartMenu", "StartMenuFolder", "Tags", "ApplicationType", "Visible", "WaitForPrinterCreation", "WorkingDirectory", "PackagedApplicationType", "PackagedApplicationVisibility" ], "enum": [ "Uid", "ClientFolder", "ApplicationGroup", "Name", "Path", "BrowserName", "CommandLineArguments", "DeliveryGroup", "Description", "PublishedName", "Enabled", "MaxTotalInstances", "MaxPerUserInstances", "ShortcutAddedToDesktop", "ShortcutAddedToStartMenu", "StartMenuFolder", "Tags", "ApplicationType", "Visible", "WaitForPrinterCreation", "WorkingDirectory", "PackagedApplicationType", "PackagedApplicationVisibility" ] }, "AppSortCriteriaRequestModel": { "title": "AppSortCriteriaRequestModel", "type": "object", "description": "Application sort criteria.\n ", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/AppSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "AppState": { "title": "AppState", "type": "string", "description": "State of a machine with respect to session launch.", "x-enumNames": [ "Unknown", "PreLogon", "PreLaunched", "Active", "Desktop", "Lingering", "NoApps" ], "enum": [ "Unknown", "PreLogon", "PreLaunched", "Active", "Desktop", "Lingering", "NoApps" ] }, "AppVApplicationDetailResponseModel": { "title": "AppVApplicationDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/AppVApplicationResponseModel" }, { "type": "object", "description": "Response object describing an App-V application details.", "additionalProperties": false, "required": [ "SequenceLocation", "TargetInPackage", "WorkingDirectory" ], "properties": { "SequenceLocation": { "title": "String", "type": "string", "description": "App sequence location.", "minLength": 1 }, "TargetInPackage": { "title": "Boolean", "type": "boolean", "description": "Whether the app target is in a package." }, "WorkingDirectory": { "title": "String", "type": "string", "description": "Working directory for the App-V application as defined on the management server.", "minLength": 1 } } } ] }, "AppVApplicationResponseModel": { "title": "AppVApplicationResponseModel", "type": "object", "description": "Response object describing an App-V application.", "additionalProperties": false, "required": [ "Id", "Name", "PackageId", "PackageName", "PackageVersion", "PackageVersionId", "PublishingServer" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The id of the App-V application.\nWas: AppVAppId", "minLength": 1 }, "Target": { "title": "String", "type": "string", "description": "Target of the App-V application.", "nullable": true }, "Identifier": { "title": "String", "type": "string", "description": "Identifier of the App-V application.", "nullable": true }, "ServerMachineConfigurationUid": { "title": "String", "type": "string", "description": "Internal property. If `null`, indicates that the\napplication type is AppLibraryAppV\nrather than AppV.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "App name.", "minLength": 1 }, "PackageId": { "title": "String", "type": "string", "description": "App package id.", "minLength": 1 }, "PackageName": { "title": "String", "type": "string", "description": "App package name.", "minLength": 1 }, "PackageExists": { "title": "Boolean", "type": "boolean", "description": "If the package exist." }, "PackageVersion": { "title": "String", "type": "string", "description": "App package version.", "minLength": 1 }, "PackageVersionId": { "title": "String", "type": "string", "description": "App package version id.", "minLength": 1 }, "PublishingServer": { "title": "String", "type": "string", "description": "App publishing server.", "minLength": 1 }, "Users": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "Users associated with the App-V application on the management server.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED. Use .` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use ." }, "BrokerApplicationNames": { "title": "String[]", "type": "array", "description": "Delivered broker application names.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "AppVApplicationResponseModelCollection": { "title": "AppVApplicationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAppVApplicationResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "AppVAppRequestModel": { "title": "AppVAppRequestModel", "type": "object", "description": "Request object for App-V application properties.", "additionalProperties": false, "required": [ "Id", "Identifier", "PackageId", "PackageName", "PackageVersion", "PackageVersionId", "SequenceLocation" ], "properties": { "Id": { "title": "String", "type": "string", "description": "App-V application Id.", "minLength": 1, "example": "For example, [{AppVPackageRoot}]\\notepad++.exe" }, "Identifier": { "title": "String", "type": "string", "description": "App-V application identifier.", "minLength": 1, "example": "For example, 0e14bc01-3d1b-4d90-bb5b-60ba8aecb637" }, "PackageId": { "title": "String", "type": "string", "description": "App-V package identifier.", "minLength": 1, "example": "For example, 256a856b-6af9-4524-b3ad-0ca9bd3532e7" }, "PackageName": { "title": "String", "type": "string", "description": "App-V package name.", "minLength": 1, "example": "For example, Notepad++.appv" }, "PackageVersion": { "title": "String", "type": "string", "description": "App-V package version.", "minLength": 1, "example": "For example, 0.0.0.1" }, "PackageVersionId": { "title": "String", "type": "string", "description": "App-V package version Id.", "minLength": 1, "example": "For example, 0.0.0.1" }, "PublishingServer": { "title": "String", "type": "string", "description": "App-V publishing server.", "nullable": true, "example": "For example, http://url.to.publishing.server:55556" }, "SequenceLocation": { "title": "String", "type": "string", "description": "App-V sequence location.", "minLength": 1, "example": "For example, \\server\\app\\Notepad++.appv" }, "ServerMachineConfigurationUid": { "title": "String", "type": "string", "description": "App-V server machine configuration Uid.", "nullable": true, "example": "For example, 0" }, "TargetInPackage": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the target is in an App-V package." } } }, "AppVAppResponseModel": { "title": "AppVAppResponseModel", "type": "object", "description": "Response object for App-V application properties.", "additionalProperties": false, "required": [ "PackageId", "PackageName", "PackageVersion", "PackageVersionId", "SequenceLocation", "TargetInPackage" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the App-V application", "nullable": true }, "PackageId": { "title": "String", "type": "string", "description": "App-V package identifier.", "minLength": 1 }, "PackageName": { "title": "String", "type": "string", "description": "App-V package name.", "minLength": 1 }, "PackageVersion": { "title": "String", "type": "string", "description": "App-V package version.", "minLength": 1 }, "PackageVersionId": { "title": "String", "type": "string", "description": "App-V package version Id.", "minLength": 1 }, "PublishingServer": { "title": "String", "type": "string", "description": "App-V publishing server.", "nullable": true }, "ManagementServer": { "title": "String", "type": "string", "description": "App-V Management server.", "nullable": true }, "SequenceLocation": { "title": "String", "type": "string", "description": "App-V sequence location.", "minLength": 1 }, "ServerMachineConfigurationUid": { "title": "String", "type": "string", "description": "App-V server machine configuration Uid.", "nullable": true }, "TargetInPackage": { "title": "Boolean", "type": "boolean", "description": "Whether the target is in an App-V package." }, "SourceTypeName": { "title": "String", "type": "string", "description": "Application Source Type Name.", "nullable": true } } }, "AppVIsolationGroupPackageRequestModel": { "title": "AppVIsolationGroupPackageRequestModel", "type": "object", "description": "Request object for an App-V IsolationGroup package.", "additionalProperties": false, "required": [ "ExplicitInclusion", "Uid" ], "properties": { "ExplicitInclusion": { "title": "Boolean", "type": "boolean", "description": "Gets or sets a value indicating whether ExplicitInclusion" }, "Uid": { "title": "Int32", "type": "integer", "description": "Uid of IsolationGroup", "format": "int32" } } }, "AppVIsolationGroupResponseModel": { "title": "AppVIsolationGroupResponseModel", "type": "object", "description": "Response object for an App-V IsolationGroup.", "additionalProperties": false, "properties": { "LibraryUid": { "title": "Int32", "type": "integer", "description": "LibraryUid of IsolationGroup", "format": "int32" }, "Name": { "title": "String", "type": "string", "description": "Name of IsolationGroup", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description of IsolationGroup", "nullable": true }, "Version": { "title": "String", "type": "string", "description": "Version of IsolationGroup", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "Uid of IsolationGroup", "format": "int32" }, "AppVPackages": { "title": "AppVPackageResponseModel[]", "type": "array", "description": "Contained AppV packages", "nullable": true, "items": { "$ref": "#/components/schemas/AppVPackageResponseModel" } } } }, "AppVIsolationGroupResponseModelCollection": { "title": "AppVIsolationGroupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAppVIsolationGroupResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "AppVPackageRequestModel": { "title": "AppVPackageRequestModel", "type": "object", "description": "Request object for add AppVPackages.", "additionalProperties": false, "properties": { "Paths": { "title": "String[]", "type": "array", "description": "AppV package path that need to import.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "AppVPackageResponseModel": { "title": "AppVPackageResponseModel", "type": "object", "description": "Default response field (Only return the fields specified there if supported in API ): AppVApplications,Description,Exists,LibraryUid,LibraryName,LibraryDescription,Name,Id,Path,Version,VersionGuid,SourceName,SourceType,SourceTypeName,OrderNumber,ExplicitInclusion,NumOfBrokerApplications,NumOfBrokerDeliveryGroups. \n Response object for an App-V package.\n ", "additionalProperties": false, "required": [ "AppVApplications", "Exists", "Name", "Id", "Path", "Version", "VersionGuid" ], "properties": { "AppVApplications": { "title": "AppVApplicationResponseModel[]", "type": "array", "description": "List of applications in the package.", "items": { "$ref": "#/components/schemas/AppVApplicationResponseModel" } }, "Description": { "title": "String", "type": "string", "description": "Description of the package.", "nullable": true }, "Exists": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the package exists." }, "LibraryUid": { "title": "Int32", "type": "integer", "description": "Id of the library which the package is in.", "format": "int32", "nullable": true }, "LibraryName": { "title": "String", "type": "string", "description": "Name of the library which the package is in.", "nullable": true }, "LibraryDescription": { "title": "String", "type": "string", "description": "Description of the library which the package is in.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Package name.", "minLength": 1 }, "Id": { "title": "String", "type": "string", "description": "Id of package.", "minLength": 1 }, "Path": { "title": "String", "type": "string", "description": "Path to package.", "minLength": 1 }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED. Use .` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use ." }, "Version": { "title": "String", "type": "string", "description": "Package version.", "minLength": 1 }, "VersionGuid": { "title": "String", "type": "string", "description": "Package version id.", "minLength": 1 }, "SourceName": { "title": "String", "type": "string", "description": "Gets or sets SourceName", "nullable": true }, "SourceType": { "description": "Gets or Sets SourceType.", "$ref": "#/components/schemas/AppVSource" }, "SourceTypeName": { "title": "String", "type": "string", "description": "Gets or sets SourceType name", "nullable": true }, "OrderNumber": { "title": "Int32", "type": "integer", "description": "Gets or sets OrderNumber", "format": "int32" }, "ExplicitInclusion": { "title": "Boolean", "type": "boolean", "description": "Gets or sets a value indicating whether ExplicitInclusion" }, "NumOfBrokerApplications": { "title": "Int32", "type": "integer", "description": "Numbers of broker applications use the package", "format": "int32" }, "NumOfBrokerDeliveryGroups": { "title": "Int32", "type": "integer", "description": "Numbers of broker deliveryGroups associate the package", "format": "int32" } } }, "AppVPackageResponseModelCollection": { "title": "AppVPackageResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAppVPackageResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "AppvServerPackageApplicationIconRequestModel": { "title": "AppvServerPackageApplicationIconRequestModel", "type": "object", "additionalProperties": false, "required": [ "Server", "PackageId", "ApplicationId" ], "properties": { "Server": { "title": "String", "type": "string", "description": "ManagementServeraddress of the App-V server", "minLength": 1 }, "PackageId": { "title": "String", "type": "string", "description": "Id of the App-V package", "minLength": 1 }, "ApplicationId": { "title": "String", "type": "string", "description": "Id of the App-V application within the package.", "minLength": 1 }, "IconFormat": { "title": "String", "type": "string", "description": "Icon format. Must be:\n`{mime-type};{width}x{height}x{colordepth}`\n\nwhere:\n\n\n* _mime-type_ must be `image/png`. (Other formats may be supported in future.)\n* _width_ and _height_ are specified in pixels.\n* _colordepth_ (optional) is either `8` or `24`.\n\nOptional. If not specified, only the raw icon data will be returned.\nNote that this is typically in ICO format, which some clients cannot\ndisplay properly.", "nullable": true } } }, "AppVServerResponseModel": { "title": "AppVServerResponseModel", "type": "object", "description": "Response object for App-V servers.", "additionalProperties": false, "required": [ "Name", "ManagementServer", "PublishingServer" ], "properties": { "Uid": { "title": "Int32", "type": "integer", "description": "Uid of App-V server.", "format": "int32" }, "Name": { "title": "String", "type": "string", "description": "Name of App-V server.", "minLength": 1 }, "ManagementServer": { "title": "String", "type": "string", "description": "Management server address. (i.e. where packages/apps are enumerated from.)", "minLength": 1 }, "PublishingServer": { "title": "String", "type": "string", "description": "Publishing server address. (i.e. where the package streams from.)", "minLength": 1 }, "IsStudioConfigured": { "title": "Boolean", "type": "boolean", "description": "Is studio configured or not." } } }, "AppVServerResponseModelCollection": { "title": "AppVServerResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAppVServerResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "AppVSource": { "title": "AppVSource", "type": "string", "description": "AppV Source enumeration.", "x-enumNames": [ "Unknown", "AppVServer", "AppLibrary" ], "enum": [ "Unknown", "AppVServer", "AppLibrary" ] }, "AssignHypervisorConnectionToImageDefinitionRequestModel": { "title": "AssignHypervisorConnectionToImageDefinitionRequestModel", "type": "object", "description": "Request object representing the assignment of hypervisor connection\nto an image definition.", "additionalProperties": false, "required": [ "HypervisorConnection" ], "properties": { "HypervisorConnection": { "title": "String", "type": "string", "description": "Specifies the hypervisor connection to assign to the image definition.", "minLength": 1 }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the image definition that are specific to the\ntarget hypervisor connection.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "AssignImageVersionToProvisioningSchemeBaseRequestModel": { "title": "AssignImageVersionToProvisioningSchemeBaseRequestModel", "type": "object", "description": "Base request object representing the assignment of image version\nto a provisioning scheme.", "additionalProperties": false, "required": [ "ImageDefinition", "ImageVersion" ], "properties": { "ImageDefinition": { "title": "String", "type": "string", "description": "The image definition of the image version to assign. May be an Id or name.", "minLength": 1 }, "ImageVersion": { "title": "String", "type": "string", "description": "The image version to assign. May be an Id or number.", "minLength": 1 } } }, "AssignImageVersionToProvisioningSchemeRequestModel": { "title": "AssignImageVersionToProvisioningSchemeRequestModel", "allOf": [ { "$ref": "#/components/schemas/AssignImageVersionToProvisioningSchemeBaseRequestModel" }, { "type": "object", "description": "Request object representing the assignment of image version\nto a provisioning scheme.", "additionalProperties": false, "properties": { "ImageAssignmentNote": { "title": "String", "type": "string", "description": "The note for assigning the prepared image to provisioning scheme.", "nullable": true } } } ] }, "AssignMachineToUserRequestModel": { "title": "AssignMachineToUserRequestModel", "type": "object", "description": "Request object representing the assignment of machines\nto a delivery group, and/or to users.", "additionalProperties": false, "required": [ "Machine" ], "properties": { "Machine": { "title": "String", "type": "string", "description": "The machine to assign. May be an Id or name.", "minLength": 1, "example": "For example, Domain01\\Machine001" }, "MachinePublishedName": { "title": "String", "type": "string", "description": "The name of the machine that is displayed in Workspace App, it\ncan be set only for static machine.", "nullable": true, "example": "[\"Display name of a machine\"]" }, "Users": { "title": "String[]", "type": "array", "description": "The user(s) to whom the machine should be assigned.\nCaller can specify SamName, UPN, or SID for each user.\nThe system should look up the entity to determine the other\nAD properties (such as DisplayName and IsGroup properties).\nGroups should be rejected.\nIf the caller passes an empty list, the machine is\nde-allocated if it was previously allocated.", "nullable": true, "example": [ "Name of a user" ], "items": { "title": "String", "type": "string" } }, "Icon": { "title": "String", "type": "string", "description": "Specifies the image data of the icon used to display the published\ndesktop to the user, and of assigned desktop(s) in the case\nwhere SharingKind\nis equal to Private.", "nullable": true, "example": "Data of the icon" } } }, "AttachedDiskResponseModel": { "title": "AttachedDiskResponseModel", "type": "object", "description": "Attached disk.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the attached disk.", "nullable": true }, "IsBootDisk": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the disk is the boot disk of the VM." }, "SizeGB": { "title": "Int32", "type": "integer", "description": "Size of the disk, in whole GB.", "format": "int32" }, "InfrastructureUid": { "title": "String", "type": "string", "description": "Opaque identifier used by the underlying infrastructure to identify the disk.", "nullable": true } } }, "Attribute": { "title": "Attribute", "type": "object", "additionalProperties": false, "properties": { "TypeId": { "title": "Object", "type": "object", "nullable": true } } }, "Authenticator": { "title": "Authenticator", "type": "string", "description": "Authentication scheme for Orchestration service.", "x-enumFlags": true, "x-enumNames": [ "None", "Basic", "IntegratedWindowsAuthentication", "BasicAndIntegratedWindowsAuthentication", "SmartCard", "BasicAndSmartCard", "All" ], "enum": [ "None", "Basic", "IntegratedWindowsAuthentication", "BasicAndIntegratedWindowsAuthentication", "SmartCard", "BasicAndSmartCard", "All" ] }, "AuthTokenResponseModel": { "title": "AuthTokenResponseModel", "type": "object", "description": "Authorization and authentication JSON Web Token model.", "additionalProperties": false, "properties": { "Token": { "title": "String", "type": "string", "description": "The FMA token.", "nullable": true }, "Principal": { "title": "String", "type": "string", "description": "The user principal.", "nullable": true }, "UserId": { "title": "String", "type": "string", "description": "The user id.", "nullable": true }, "CustomerId": { "title": "String", "type": "string", "description": "The customer id.", "nullable": true }, "ExpiresAt": { "title": "String", "type": "string", "description": "The token will expire at the UTC time.", "nullable": true } } }, "AutoDiscoveryPeriod": { "title": "AutoDiscoveryPeriod", "type": "string", "description": "", "x-enumNames": [ "None", "Hour", "Day", "Week" ], "enum": [ "None", "Hour", "Day", "Week" ] }, "AutoscaleGroupPluginModel": { "title": "AutoscaleGroupPluginModel", "type": "object", "additionalProperties": false, "properties": { "Uid": { "title": "Int32", "type": "integer", "description": "The unique ID of the desktop group associated with this group plugin.", "format": "int32" }, "Name": { "title": "String", "type": "string", "description": "The name of the group plugin.", "nullable": true }, "Priority": { "title": "Int32", "type": "integer", "description": "The priority of this group plugin with respect to other group plugins associated with the same desktop group.\nPriority 1 is the highest priority.", "format": "int32" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the group plugin is enabled." }, "Description": { "title": "String", "type": "string", "description": "Optional description of the group plugin.", "nullable": true }, "DesktopGroupUid": { "title": "Int32", "type": "integer", "description": "The unique ID of the desktop group associated with this group plugin.", "format": "int32" }, "Type": { "description": "Autoscale plugin type.", "$ref": "#/components/schemas/AutoscalePluginType" }, "AutoApprove": { "title": "Boolean", "type": "boolean", "description": "If True, indicates that any schedule override produced by the plugin is automatically accepted as the schedule for the target date. Otherwise the\nschedule is only accepted if the target date is on or before the date specified in ApprovedUtil. If AutoApprove is False and the ApprovedUtil date is\nnot set, or is in the past, then any schedule override produced is discarded without being used." }, "ApprovedUntil": { "title": "String", "type": "string", "description": "If AutoApprove is False, specifies the date until which any schedule override produced by the plugin is automatically accepted as the schedule\nfor the target date. See AutoApprove for more information.", "nullable": true }, "Configuration": { "title": "String", "type": "string", "description": "Raw configuration JSON string from Broker.\nThis is preserved for conversion to response models at higher layers.\nType-specific properties (e.g., Dates, OverrideTimeSchemeUid) should be parsed\nfrom this Configuration at the response model layer.", "nullable": true } } }, "AutoscaleGroupPluginResponseModel": { "title": "AutoscaleGroupPluginResponseModel", "type": "object", "description": "Autoscale group plugin response model.", "additionalProperties": false, "properties": { "Uid": { "title": "Int32", "type": "integer", "description": "The unique ID of the autoscale group plugin.", "format": "int32" }, "Name": { "title": "String", "type": "string", "description": "The name of the group plugin.", "nullable": true }, "Type": { "description": "Autoscale plugin type. Acts as the discriminator for determining which subclass is returned.", "$ref": "#/components/schemas/AutoscalePluginType" }, "Priority": { "title": "Int32", "type": "integer", "description": "The priority of this group plugin with respect to other group plugins associated with the same desktop group.\nPriority 1 is the highest priority.", "format": "int32" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the group plugin is enabled." }, "Description": { "title": "String", "type": "string", "description": "Optional description of the group plugin.", "nullable": true }, "DesktopGroupUid": { "title": "Int32", "type": "integer", "description": "The unique ID of the desktop group associated with this group plugin.", "format": "int32" }, "AutoApprove": { "title": "Boolean", "type": "boolean", "description": "If True, indicates that any schedule override produced by the plugin is automatically accepted as the schedule for the target date." }, "ApprovedUntil": { "title": "String", "type": "string", "description": "If AutoApprove is False, specifies the date until which any schedule override produced by the plugin is automatically accepted as the schedule\nfor the target date.", "nullable": true } } }, "AutoscaleGroupPluginResponseModelCollection": { "title": "AutoscaleGroupPluginResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAutoscaleGroupPluginResponseModel" }, { "type": "object", "description": "Autoscale group plugin response model collection.\nContains polymorphic response models (Holiday or Intelligent subtypes).", "additionalProperties": false } ] }, "AutoscalePluginTemplateResponseModel": { "title": "AutoscalePluginTemplateResponseModel", "type": "object", "description": "The autoscale plugin template response model.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Autoscale plugin template name.", "nullable": true }, "Type": { "description": "Autoscale plugin type.", "$ref": "#/components/schemas/AutoscalePluginType" }, "Dates": { "title": "String[]", "type": "array", "description": "Date range for the autoscale holiday plugin template.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "AutoscalePluginTemplateResponseModelCollection": { "title": "AutoscalePluginTemplateResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAutoscalePluginTemplateResponseModel" }, { "type": "object", "description": "Autoscale plugin template response model collection", "additionalProperties": false } ] }, "AutoscalePluginType": { "title": "AutoscalePluginType", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Holiday", "Intelligent" ], "enum": [ "Unknown", "Holiday", "Intelligent" ] }, "AutoscaleScaleDownAction": { "title": "AutoscaleScaleDownAction", "type": "string", "description": "", "x-enumNames": [ "Shutdown", "Suspend" ], "enum": [ "Shutdown", "Suspend" ] }, "AzureADCustomDomainResponseModel": { "title": "AzureADCustomDomainResponseModel", "type": "object", "description": "Information of Microsoft Entra ID custom domain", "additionalProperties": false, "properties": { "TenantId": { "title": "String", "type": "string", "description": "The tenant ID. For example, 00000000-0000-0000-0000-000000000000.", "nullable": true }, "TenantDisplayName": { "title": "String", "type": "string", "description": "The display name of the tenant.", "nullable": true }, "AuthenticationType": { "title": "String", "type": "string", "description": "The authentication type of the domain. Valid values are: Managed and Federated.", "nullable": true } } }, "AzureAdJoinedMode": { "title": "AzureAdJoinedMode", "type": "string", "description": "Azure AD joined type for machines", "x-enumNames": [ "Unknown", "NotAadJoined", "HybridAadJoined", "PureAadJoined" ], "enum": [ "Unknown", "NotAadJoined", "HybridAadJoined", "PureAadJoined" ] }, "AzureAdJoinType": { "title": "AzureAdJoinType", "type": "string", "description": "Azure AD join type for machines", "x-enumNames": [ "Unknown", "None", "Hybrid", "Pure" ], "enum": [ "Unknown", "None", "Hybrid", "Pure" ] }, "AzureADSecurityGroupResponseModel": { "title": "AzureADSecurityGroupResponseModel", "type": "object", "description": "The universal Microsoft Entra ID security group object.", "additionalProperties": false, "properties": { "ObjectId": { "title": "String", "type": "string", "description": "The objectId of SecurityGroup", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "The Name of AzureAdSecurityGroup", "nullable": true }, "Type": { "title": "String", "type": "string", "description": "The Type of AzureAdSecurityGroup", "nullable": true }, "MembershipRule": { "title": "String", "type": "string", "description": "The MembershipRule of AzureAdSecurityGroup", "nullable": true } } }, "AzureADSecurityGroupResponseModelCollection": { "title": "AzureADSecurityGroupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfAzureADSecurityGroupResponseModel" }, { "type": "object", "description": "Response object for collections of IdentityDirectoryResponseModel.", "additionalProperties": false } ] }, "AzureEnvironment": { "title": "AzureEnvironment", "type": "string", "description": "Azure environments", "x-enumNames": [ "Custom", "AzureCloud", "AzureChinaCloud", "AzureUSGovernment", "AzureGermanCloud" ], "enum": [ "Custom", "AzureCloud", "AzureChinaCloud", "AzureUSGovernment", "AzureGermanCloud" ] }, "BackupDoBackupResponseModel": { "title": "BackupDoBackupResponseModel", "type": "object", "description": "Do backup response model", "additionalProperties": false, "required": [ "ExecutionId", "Result" ], "properties": { "ExecutionId": { "title": "String", "type": "string", "description": "Backup Execution Id: GUID", "minLength": 1 }, "Result": { "$ref": "#/components/schemas/BackupRestoreActionStartStatus" } } }, "BackupMembersResponseModelCollection": { "title": "BackupMembersResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfBackupRestoreMemberResponseModel" }, { "type": "object", "description": "Backup response model collection", "additionalProperties": false } ] }, "BackupResponseModelCollection": { "title": "BackupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfBackupRestoreBackupResponseModel" }, { "type": "object", "description": "Backup response model collection", "additionalProperties": false } ] }, "BackupRestoreActions": { "title": "BackupRestoreActions", "type": "string", "description": "", "x-enumNames": [ "Backup", "Restore", "PinBackup", "UnpinBackup", "DownloadBackup", "UploadBackup", "DeleteBackup", "DeleteSchedule", "CreateSchedule", "EditSchedule", "EnableSchedule", "DisableSchedule", "GetMembersInFile", "Undefined" ], "enum": [ "Backup", "Restore", "PinBackup", "UnpinBackup", "DownloadBackup", "UploadBackup", "DeleteBackup", "DeleteSchedule", "CreateSchedule", "EditSchedule", "EnableSchedule", "DisableSchedule", "GetMembersInFile", "Undefined" ] }, "BackupRestoreActionStartStatus": { "title": "BackupRestoreActionStartStatus", "type": "string", "description": "Action start status", "x-enumNames": [ "Failed", "Success", "ExistingActionInProgress", "ExistingBackupInProgress", "ExistingRestoreInProgress", "StorageNotValid" ], "enum": [ "Failed", "Success", "ExistingActionInProgress", "ExistingBackupInProgress", "ExistingRestoreInProgress", "StorageNotValid" ] }, "BackupRestoreBackupResponseModel": { "title": "BackupRestoreBackupResponseModel", "type": "object", "additionalProperties": false, "properties": { "BackupName": { "title": "String", "type": "string", "description": "Backup File name", "nullable": true }, "Notes": { "title": "String", "type": "string", "description": "Notes", "nullable": true }, "Pinned": { "title": "Boolean", "type": "boolean", "description": "Pinned = true, unpinned = false" }, "DateTime": { "title": "DateTime", "type": "string", "description": "Backup date and time", "format": "date-time" }, "HistoryUid": { "title": "Int32", "type": "integer", "description": "Hisotry Uid", "format": "int32" }, "RelatedUid": { "title": "Int32", "type": "integer", "description": "Related history UID", "format": "int32" }, "RelatedDate": { "title": "DateTime", "type": "string", "description": "Related history Date/Time", "format": "date-time" }, "RelatedIsCheckMode": { "title": "Boolean", "type": "boolean", "description": "Related Restore was run in check mode" }, "Duration": { "title": "Int32", "type": "integer", "description": "Duration in seconds", "format": "int32" }, "AdministratorName": { "title": "String", "type": "string", "description": "Administrator Name", "nullable": true }, "Details": { "title": "Dictionary`2", "type": "object", "description": "Details", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "Result": { "title": "Boolean", "type": "boolean", "description": "Result" }, "BackupSize": { "title": "Int64", "type": "integer", "description": "Backup size in bytes", "format": "int64" }, "ScheduleUid": { "title": "Int32", "type": "integer", "description": "Schedule UID that created this backup (0 if manual backup)", "format": "int32" }, "ScheduleName": { "title": "String", "type": "string", "description": "Schedule name that created this backup (empty if manual backup)", "nullable": true } } }, "BackupRestoreBlobStorage": { "title": "BackupRestoreBlobStorage", "type": "string", "description": "Blob Storage types", "x-enumNames": [ "Undefined", "FileStorage", "AzureStorage", "CustomerAzureStorage", "AwsStorage", "CustomerAwsStorage", "GoogleCloudStorage", "CustomerGoogleCloudStorage", "CustomStorage" ], "enum": [ "Undefined", "FileStorage", "AzureStorage", "CustomerAzureStorage", "AwsStorage", "CustomerAwsStorage", "GoogleCloudStorage", "CustomerGoogleCloudStorage", "CustomStorage" ] }, "BackupRestoreComponentControlPlane": { "title": "BackupRestoreComponentControlPlane", "type": "string", "description": "", "x-enumNames": [ "OnPremOnly", "CloudOnly", "Both", "Neither" ], "enum": [ "OnPremOnly", "CloudOnly", "Both", "Neither" ] }, "BackupRestoreCvadSecurityInfo": { "title": "BackupRestoreCvadSecurityInfo", "type": "object", "additionalProperties": false, "properties": { "SecurityName": { "title": "String", "type": "string", "nullable": true }, "SecurityType": { "$ref": "#/components/schemas/CvadSecurityTypes" }, "Secret": { "title": "String", "type": "string", "nullable": true } } }, "BackupRestoreDoBackupRequestModel": { "title": "BackupRestoreDoBackupRequestModel", "type": "object", "description": "Do Backup Request", "additionalProperties": false, "properties": { "Notes": { "title": "String", "type": "string", "description": "Notes\n ", "nullable": true }, "ScheduleName": { "title": "String", "type": "string", "description": "Schedule Name; for logging purposes only", "nullable": true }, "ScheduleUid": { "title": "Int32", "type": "integer", "description": "Schedule UID that created this backup (0 if manual backup)", "format": "int32" } } }, "BackupRestoreDownloadResponseModel": { "title": "BackupRestoreDownloadResponseModel", "type": "object", "additionalProperties": false, "properties": { "Result": { "description": "Download result\n ", "$ref": "#/components/schemas/BackupRestoreActionStartStatus" }, "BackupBinaryData": { "title": "Byte[]", "type": "string", "description": "Downloaded binary data; may be complete or partial", "format": "byte", "nullable": true }, "BackupSize": { "title": "Int64", "type": "integer", "description": "Total backup size", "format": "int64" }, "SizeTransferred": { "title": "Int32", "type": "integer", "description": "Size transferred in this response", "format": "int32" }, "BackupMemberCount": { "title": "Int32", "type": "integer", "description": "Number of members in downloaded zip when more than a backup is included (such as an associated restore failure)", "format": "int32" }, "ContinuationToken": { "title": "String", "type": "string", "description": "Continuation token when this is a partial download. When empty then the download is complete.", "nullable": true } } }, "BackupRestoreFixupModel": { "title": "BackupRestoreFixupModel", "type": "object", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Fixup Identifier", "nullable": true }, "Severity": { "description": "Fixup severity used to control visual presentation\n ", "$ref": "#/components/schemas/FixupSeverity" }, "LocalizedFixup": { "title": "String", "type": "string", "description": "List of parameters used in fixup string formatting", "nullable": true } } }, "BackupRestoreGetComponentMemberRequestModel": { "title": "BackupRestoreGetComponentMemberRequestModel", "type": "object", "additionalProperties": false, "required": [ "Component" ], "properties": { "Component": { "description": "Component in backup to restore\n ", "$ref": "#/components/schemas/BckRstrAutoConfigComponents" }, "Filters": { "title": "String", "type": "string", "description": "Comma delimted component member names to restore; may include wildcards", "nullable": true } } }, "BackupRestoreHistoryInformation": { "title": "BackupRestoreHistoryInformation", "type": "object", "description": "Single history for backup / restore operations", "additionalProperties": false, "required": [ "Action", "HistoryId", "Successful" ], "properties": { "Uid": { "title": "Int32", "type": "integer", "description": "Unique Identifier\n ", "format": "int32" }, "Action": { "description": "Action such as backup, restore etc...\n ", "$ref": "#/components/schemas/BackupRestoreActions" }, "HistoryId": { "title": "String", "type": "string", "description": "History entry ID", "minLength": 1 }, "Successful": { "title": "Boolean", "type": "boolean", "description": "True if successful, false if not successful" }, "Duration": { "title": "Int32", "type": "integer", "description": "Duration in seconds", "format": "int32" }, "TimeZoneOffset": { "title": "Int32", "type": "integer", "description": "TimeZone offset from UTC", "format": "int32" }, "DateTime": { "title": "DateTime", "type": "string", "description": "Date and time the action was started", "format": "date-time" }, "Notes": { "title": "String", "type": "string", "description": "Notes about the action", "nullable": true }, "RestoreType": { "description": "Restore type (applicable only when the action was restore)", "$ref": "#/components/schemas/BackupRestoreRestoreTypes" }, "Filters": { "title": "String", "type": "string", "description": "Filters used (applicable only when the action was restore)", "nullable": true }, "WithPrerequisites": { "title": "Boolean", "type": "boolean", "description": "With Prerequisites (applicable only when the action was restore)" }, "CheckMode": { "title": "Boolean", "type": "boolean", "description": "Check mode (applicable only when the action was restore)" }, "ScheduleName": { "title": "String", "type": "string", "description": "Name of schedule to perform backup (applicable only when the action was backup)", "nullable": true }, "Component": { "description": "Component being restored (applicable only when the action was restore)", "$ref": "#/components/schemas/BckRstrAutoConfigComponents" }, "ExecutionId": { "title": "String", "type": "string", "description": "Execution Id", "nullable": true }, "BackupName": { "title": "String", "type": "string", "description": "Backup name", "nullable": true }, "BackupSize": { "title": "Int64", "type": "integer", "description": "Backup size", "format": "int64" }, "BackupFileSpec": { "title": "String", "type": "string", "description": "Backup File Specification", "nullable": true }, "RelatedUid": { "title": "Int32", "type": "integer", "description": "Related History UID for restore with checkmode set to true", "format": "int32" }, "RelatedDate": { "title": "DateTime", "type": "string", "description": "Related History date for restore with checkmode set to true", "format": "date-time" }, "RelatedIsCheckMode": { "title": "Boolean", "type": "boolean", "description": "Related is run as check mode" }, "Pinned": { "title": "Boolean", "type": "boolean", "description": "Backup is pinned" }, "AdministratorName": { "title": "String", "type": "string", "description": "Administrator Name", "nullable": true }, "BackupDetails": { "title": "Dictionary`2", "type": "object", "description": "Backup Status Details", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "RestoreDetails": { "title": "List`1", "type": "array", "description": "Restore Status Details", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreRestoreSingleMemberModel" } }, "SimpleResults": { "title": "List`1", "type": "array", "description": "Simple Results (such as Get backed up member names)", "nullable": true, "items": { "title": "String", "type": "string" } }, "Fixups": { "title": "List`1", "type": "array", "description": "Fixups ", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreFixupModel" } } } }, "BackupRestoreHistoryResponseModelCollection": { "title": "BackupRestoreHistoryResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfBackupRestoreHistoryInformation" }, { "type": "object", "description": "Backup / Restore History response model collection", "additionalProperties": false } ] }, "BackupRestoreInformationResponseModel": { "title": "BackupRestoreInformationResponseModel", "type": "object", "description": "Response object for a backups.", "additionalProperties": false, "required": [ "MaxAutoPinnedBackups", "MaxPinnedBackups", "MaxSavedBackups" ], "properties": { "MaxAutoPinnedBackups": { "title": "Int32", "type": "integer", "description": "Max automatic pinned backups via schedules.", "format": "int32" }, "MaxPinnedBackups": { "title": "Int32", "type": "integer", "description": "Max pinned backups. Pinned backups cannot be deleted; they must first\nbe unpinned and then they can be manually deleted or automatically\ndeleted if old and a new backup is done and the max backups exceeded", "format": "int32" }, "MaxSavedBackups": { "title": "Int32", "type": "integer", "description": "Max saved backups. Unpinned backups will be removed when a new backup is completed\nand the number of saved backups exceeds this value", "format": "int32" }, "StaleStatusTimeoutInSeconds": { "title": "Int32", "type": "integer", "description": "Stale status timeout in seconds; when current status is to old to be balid", "format": "int32" }, "ComponentInformation": { "title": "BackupRestoreSingleComponentInfo[]", "type": "array", "description": "Component information", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreSingleComponentInfo" } } } }, "BackupRestoreMemberResponseModel": { "title": "BackupRestoreMemberResponseModel", "type": "object", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Member Name", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Member Description\n ", "nullable": true }, "Details": { "title": "String", "type": "string", "description": "Member details (YAML for single emmber)", "nullable": true } } }, "BackupRestoreOptionsModel": { "title": "BackupRestoreOptionsModel", "type": "object", "additionalProperties": false, "properties": { "OneScheduledBackupPerDay": { "title": "Boolean", "type": "boolean", "nullable": true }, "AutoPinScheduleUid": { "title": "Int32", "type": "integer", "format": "int32", "nullable": true }, "AutoPinScheduleName": { "title": "String", "type": "string", "nullable": true } } }, "BackupRestoreOptionsRequestModel": { "title": "BackupRestoreOptionsRequestModel", "allOf": [ { "$ref": "#/components/schemas/BackupRestoreOptionsModel" }, { "type": "object", "additionalProperties": false } ] }, "BackupRestoreOptionsResponseModel": { "title": "BackupRestoreOptionsResponseModel", "allOf": [ { "$ref": "#/components/schemas/BackupRestoreOptionsModel" }, { "type": "object", "additionalProperties": false, "properties": { "result": { "title": "Boolean", "type": "boolean" } } } ] }, "BackupRestorePlaybookActionState": { "title": "BackupRestorePlaybookActionState", "type": "string", "description": "Backup / Restore Restore Progress", "x-enumNames": [ "Unknown", "Reading", "ReadingCloud", "Evaluating", "PrereqEvaluating", "AddingUpdatingDeleting", "Adding", "Updating", "Deleting", "ReReading", "Verifying", "Verified", "VerifyFailed", "Complete", "Writing", "Failed", "Skipping", "SkipDueToMissingInfo", "AddStarted", "UpdateStarted", "DeleteStarted" ], "enum": [ "Unknown", "Reading", "ReadingCloud", "Evaluating", "PrereqEvaluating", "AddingUpdatingDeleting", "Adding", "Updating", "Deleting", "ReReading", "Verifying", "Verified", "VerifyFailed", "Complete", "Writing", "Failed", "Skipping", "SkipDueToMissingInfo", "AddStarted", "UpdateStarted", "DeleteStarted" ] }, "BackupRestoreRestoreBackupRequestModel": { "title": "BackupRestoreRestoreBackupRequestModel", "type": "object", "description": "Restore Backup Request Model", "additionalProperties": false, "required": [ "BackupName", "HistoryUid", "Component" ], "properties": { "BackupName": { "title": "String", "type": "string", "description": "Name of backup to restore ", "minLength": 1 }, "HistoryUid": { "title": "Int32", "type": "integer", "description": "Hisotry Uid", "format": "int32" }, "Component": { "description": "Component in backup to restore\n ", "$ref": "#/components/schemas/BckRstrAutoConfigComponents" }, "Filters": { "title": "String", "type": "string", "description": "Comma delimted component member names to restore; may include wildcards", "nullable": true }, "WithPrereq": { "title": "Boolean", "type": "boolean", "description": "Restore component prerequisites as necessary" }, "Checkmode": { "title": "Boolean", "type": "boolean", "description": "Determine what should be restored but to not do the actual restore; report only\n " }, "Notes": { "title": "String", "type": "string", "description": "Admin entered notes", "nullable": true }, "RestoreType": { "description": "Restore Type\n ", "$ref": "#/components/schemas/BackupRestoreRestoreTypes" }, "CvadSecurityInfo": { "title": "BackupRestoreCvadSecurityInfo[]", "type": "array", "description": "Cvad Security info valid only when Component is HostConnections", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreCvadSecurityInfo" } } } }, "BackupRestoreRestoreBackupResponseModel": { "title": "BackupRestoreRestoreBackupResponseModel", "type": "object", "description": "Restore Backup response model", "additionalProperties": false, "required": [ "ExecutionId", "Result" ], "properties": { "ExecutionId": { "title": "String", "type": "string", "description": "Restore Execution Id: GUID", "minLength": 1 }, "Result": { "$ref": "#/components/schemas/BackupRestoreActionStartStatus" } } }, "BackupRestoreRestoreSingleMemberModel": { "title": "BackupRestoreRestoreSingleMemberModel", "type": "object", "additionalProperties": false, "properties": { "ComponentName": { "title": "String", "type": "string", "description": "Component Name", "nullable": true }, "MemberName": { "title": "String", "type": "string", "description": "Member Name", "nullable": true }, "MemberType": { "title": "String", "type": "string", "description": "Member Type (Host Connections Only)", "nullable": true }, "PlaybookActionState": { "description": "Playbook Action", "$ref": "#/components/schemas/BackupRestorePlaybookActionState" }, "Result": { "title": "Boolean", "type": "boolean", "description": "Result" }, "Details": { "title": "String", "type": "string", "description": "Details or Error Message", "nullable": true }, "TransactionId": { "title": "String", "type": "string", "description": "Transaction Id", "nullable": true }, "DateTime": { "title": "DateTime", "type": "string", "description": "Date Time stamps", "format": "date-time" }, "MemberCount": { "title": "Int32", "type": "integer", "description": "Member Count", "format": "int32" }, "CurrentMemberIndex": { "title": "Int32", "type": "integer", "format": "int32" }, "Fixups": { "title": "String", "type": "string", "description": "Json string containing ACT internal Fixups data.\nMust be exchanged with ACT to obtain human readable fixups.", "nullable": true }, "CheckMode": { "title": "Boolean", "type": "boolean", "description": "Check Mode" } } }, "BackupRestoreRestoreTypes": { "title": "BackupRestoreRestoreTypes", "type": "string", "description": "Restore Types ", "x-enumNames": [ "Undefined", "MissingOnly", "MissingUpdateExisting", "MissingUpdateExistingRemoveNew" ], "enum": [ "Undefined", "MissingOnly", "MissingUpdateExisting", "MissingUpdateExistingRemoveNew" ] }, "BackupRestoreResultLogResponseModel": { "title": "BackupRestoreResultLogResponseModel", "type": "object", "additionalProperties": false, "properties": { "ResultLog": { "title": "String", "type": "string", "nullable": true } } }, "BackupRestoreScheduleDays": { "title": "BackupRestoreScheduleDays", "type": "string", "description": "Backup Restore Schedule Days", "x-enumFlags": true, "x-enumNames": [ "NotDefined", "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "enum": [ "NotDefined", "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "BackupRestoreScheduleFrequency": { "title": "BackupRestoreScheduleFrequency", "type": "string", "description": "Backup Restore Schedule Frequency", "x-enumNames": [ "Daily", "Weekly", "Monthly", "Once", "NotDefined" ], "enum": [ "Daily", "Weekly", "Monthly", "Once", "NotDefined" ] }, "BackupRestoreScheduleModel": { "title": "BackupRestoreScheduleModel", "type": "object", "description": "Backup / Restore Schedule Model", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "Id", "format": "int32" }, "Day": { "description": "Day", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "DaysInWeek": { "title": "BackupRestoreScheduleDays[]", "type": "array", "description": "Days in Week", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreScheduleDays" } }, "DayInMonth": { "description": "Days in Month", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "WeekInMonth": { "description": "Weeks in Month", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleWeeks" }, "StartDate": { "title": "String", "type": "string", "description": "Start Date", "nullable": true }, "FrequencyFactor": { "title": "Int32", "type": "integer", "description": "Frequency Factor", "format": "int32", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Enabled\n " }, "Frequency": { "description": "Frequency\n ", "$ref": "#/components/schemas/BackupRestoreScheduleFrequency" }, "StartTime": { "title": "String", "type": "string", "description": "Start Time", "nullable": true }, "TimeZoneId": { "title": "String", "type": "string", "description": "Time Zone Id\n ", "nullable": true }, "Notes": { "title": "String", "type": "string", "description": "Notes added to backup ", "nullable": true }, "LastRunTime": { "title": "String", "type": "string", "description": "Last Run Time", "nullable": true } } }, "BackupRestoreScheduleModelCollection": { "title": "BackupRestoreScheduleModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfBackupRestoreScheduleModel" }, { "type": "object", "description": "Response object for collections of CatalogSearchResponseModel.", "additionalProperties": false } ] }, "BackupRestoreScheduleRequestModel": { "title": "BackupRestoreScheduleRequestModel", "type": "object", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name", "nullable": true }, "Day": { "description": "Day", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "DaysInWeek": { "title": "BackupRestoreScheduleDays[]", "type": "array", "description": "Days in Week", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreScheduleDays" } }, "DayInMonth": { "description": "Days in Month", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "WeekInMonth": { "description": "Weeks in Month", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleWeeks" }, "StartDate": { "title": "String", "type": "string", "description": "Start Date", "nullable": true }, "FrequencyFactor": { "title": "Int32", "type": "integer", "description": "Frequency Factor", "format": "int32", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Enabled\n ", "nullable": true }, "Frequency": { "description": "Frequency\n ", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleFrequency" }, "StartTime": { "title": "String", "type": "string", "description": "Start Time", "nullable": true }, "TimeZoneId": { "title": "String", "type": "string", "description": "Time Zone Id", "nullable": true } } }, "BackupRestoreScheduleResponseModel": { "title": "BackupRestoreScheduleResponseModel", "type": "object", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "Id", "format": "int32" }, "Day": { "description": "Day", "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "DaysInWeek": { "title": "BackupRestoreScheduleDays[]", "type": "array", "description": "Days in Week", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreScheduleDays" } }, "DayInMonth": { "description": "Days in Month", "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "WeekInMonth": { "description": "Weeks in Month", "$ref": "#/components/schemas/BackupRestoreScheduleWeeks" }, "StartDate": { "title": "String", "type": "string", "description": "Start Date", "nullable": true }, "FrequencyFactor": { "title": "Int32", "type": "integer", "description": "Frequency Factor", "format": "int32" }, "Description": { "title": "String", "type": "string", "description": "Description", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Enabled\n " }, "Frequency": { "description": "Frequency\n ", "$ref": "#/components/schemas/BackupRestoreScheduleFrequency" }, "StartTime": { "title": "String", "type": "string", "description": "Start Time", "nullable": true }, "TimeZoneId": { "title": "String", "type": "string", "description": "Time Zone Id\n ", "nullable": true } } }, "BackupRestoreScheduleWeeks": { "title": "BackupRestoreScheduleWeeks", "type": "string", "description": "Backup Restore Schedule Weeks\n ", "x-enumNames": [ "NotDefined", "First", "Second", "Third", "Fourth", "Last" ], "enum": [ "NotDefined", "First", "Second", "Third", "Fourth", "Last" ] }, "BackupRestoreSingleComponentInfo": { "title": "BackupRestoreSingleComponentInfo", "type": "object", "additionalProperties": false, "properties": { "LocalizedName": { "title": "String", "type": "string", "description": "Localized component name", "nullable": true }, "Component": { "description": "Component", "$ref": "#/components/schemas/BckRstrAutoConfigComponents" }, "ControlPlane": { "description": "Control plane component is valid in", "$ref": "#/components/schemas/BackupRestoreComponentControlPlane" }, "PreImportCheckMode": { "title": "Boolean", "type": "boolean", "description": "Pre-Import check mode; prompt for secrets prior to restoring" }, "MembersViewable": { "title": "Boolean", "type": "boolean", "description": "Compnent member names are viewable" }, "WithPrequisites": { "title": "Boolean", "type": "boolean", "description": "Component supports restoring with prerequisites" }, "CanBeRestored": { "title": "Boolean", "type": "boolean", "description": "Component can be restored" }, "HasDescription": { "title": "Boolean", "type": "boolean", "description": "Component members have descriptions" }, "OnPremOnly": { "title": "Boolean", "type": "boolean", "description": "Component valid On-Prem only" } } }, "BackupRestoreStatus": { "title": "BackupRestoreStatus", "type": "string", "description": "Backup / Restore Status", "x-enumNames": [ "Unknown", "Pending", "InProgress", "PreComplete", "Complete", "CompleteWithWarning", "Failed", "Canceled", "NonTerminatingError", "Stalled", "RetryBackup", "RetryRestore", "AuditComplete" ], "enum": [ "Unknown", "Pending", "InProgress", "PreComplete", "Complete", "CompleteWithWarning", "Failed", "Canceled", "NonTerminatingError", "Stalled", "RetryBackup", "RetryRestore", "AuditComplete" ] }, "BackupRestoreStatusRequestModel": { "title": "BackupRestoreStatusRequestModel", "type": "object", "additionalProperties": false, "required": [ "Action", "ExecutionId", "Duration", "Status", "StartTime", "CurrentTime" ], "properties": { "Action": { "description": "Backup / Restore Action", "$ref": "#/components/schemas/BackupRestoreActions" }, "ExecutionId": { "title": "String", "type": "string", "description": "Execution Id", "minLength": 1 }, "Duration": { "title": "Int32", "type": "integer", "description": "Current/Total duration in seconds", "format": "int32" }, "RestApiDuration": { "title": "Int32", "type": "integer", "description": "Current/Total Rest API duration in seconds", "format": "int32" }, "Status": { "description": "Backup / Restore Status", "$ref": "#/components/schemas/BackupRestoreStatus" }, "BackupName": { "title": "String", "type": "string", "description": "Backup Name", "nullable": true }, "BackupSize": { "title": "Int64", "type": "integer", "description": "Backup Size", "format": "int64" }, "ScheduleName": { "title": "String", "type": "string", "description": "Schedule Name", "nullable": true }, "MemberCount": { "title": "Int32", "type": "integer", "description": "Member Count", "format": "int32" }, "StartTime": { "title": "DateTime", "type": "string", "description": "Action Start UTC Time\n ", "format": "date-time", "minLength": 1 }, "CurrentTime": { "title": "DateTime", "type": "string", "description": "Action Current UTC Time", "format": "date-time", "minLength": 1 }, "RestoreProgress": { "description": "Restore Progress\n ", "nullable": true, "$ref": "#/components/schemas/BackupRestoreRestoreSingleMemberModel" }, "ActivityCount": { "title": "Int32", "type": "integer", "description": "Activity count for stall testing", "format": "int32" }, "CurrentComponent": { "title": "String", "type": "string", "description": "Current component being restored", "nullable": true }, "CurrentMemberName": { "title": "String", "type": "string", "description": "Current component member being restored", "nullable": true }, "ComponentProgress": { "description": "Current restoring component's state\n ", "$ref": "#/components/schemas/BackupRestorePlaybookActionState" }, "CheckMode": { "title": "Boolean", "type": "boolean", "description": "Check Mode" }, "PreImportCheckMode": { "title": "Boolean", "type": "boolean", "description": "Pre-Import Check Mode" }, "AdministratrName": { "title": "String", "type": "string", "description": "AdministratorName", "nullable": true }, "IsBackupRetry": { "title": "Boolean", "type": "boolean", "description": "Is this backup a retry after a failed backup" }, "BackupDetails": { "title": "Dictionary`2", "type": "object", "description": "Backup Status Details", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "RestoreDetails": { "title": "List`1", "type": "array", "description": "Restore Status Details", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreRestoreSingleMemberModel" } }, "SimpleResults": { "title": "List`1", "type": "array", "description": "Simple Results (such as Get backed up member names)", "nullable": true, "items": { "title": "String", "type": "string" } }, "Fixups": { "title": "String", "type": "string", "description": "Fixups from backups or restores", "nullable": true }, "RestoreType": { "description": "Restore Type\n ", "$ref": "#/components/schemas/BackupRestoreRestoreTypes" } } }, "BackupRestoreStatusResponseModel": { "title": "BackupRestoreStatusResponseModel", "type": "object", "additionalProperties": false, "required": [ "Action", "ExecutionId", "Duration", "RestApiDuration", "Status" ], "properties": { "Action": { "description": "Current Action in progress", "$ref": "#/components/schemas/BackupRestoreActions" }, "ExecutionId": { "title": "String", "type": "string", "description": "Execution ID of operation", "minLength": 1 }, "Duration": { "title": "Int32", "type": "integer", "description": "Current/Total duration in seconds", "format": "int32" }, "RestApiDuration": { "title": "Int32", "type": "integer", "description": "Current/Total Rest API duration in seconds", "format": "int32" }, "Status": { "description": "Status of operation", "$ref": "#/components/schemas/BackupRestoreStatus" }, "BackupName": { "title": "String", "type": "string", "description": "Backup name being created by backup operation or backup name being restored from", "nullable": true }, "ScheduleName": { "title": "String", "type": "string", "description": "Schedule Name", "nullable": true }, "Notes": { "title": "String", "type": "string", "description": "Backup name being created by backup operation or backup name being restored from", "nullable": true }, "ContinueAction": { "title": "Boolean", "type": "boolean", "description": "Continue Action: True = Continue Action, False = Stop action" }, "StartTime": { "title": "DateTime", "type": "string", "description": "Action Start UTC Time\n ", "format": "date-time" }, "CurrentTime": { "title": "DateTime", "type": "string", "description": "Action Current UTC Time", "format": "date-time" }, "ActivityCount": { "title": "Int32", "type": "integer", "description": "Activity count for stall testing", "format": "int32" }, "CurrentComponent": { "description": "Current component being restored", "$ref": "#/components/schemas/BckRstrAutoConfigComponents" }, "CurrentMemberName": { "title": "String", "type": "string", "description": "Current component member being restored", "nullable": true }, "MemberCount": { "title": "Int32", "type": "integer", "description": "Member Count", "format": "int32" }, "ComponentProgress": { "description": "Current restoring component's state\n ", "$ref": "#/components/schemas/BackupRestorePlaybookActionState" }, "CheckMode": { "title": "Boolean", "type": "boolean", "description": "Check Mode restore from backup" }, "PreImportCheckMode": { "title": "Boolean", "type": "boolean", "description": "Pre-Import Check Mode" }, "Filters": { "title": "String", "type": "string", "description": "Filters used by restore from backup", "nullable": true }, "AdministratrName": { "title": "String", "type": "string", "description": "AdministratorName", "nullable": true }, "IsBackupRetry": { "title": "Boolean", "type": "boolean", "description": "Is this a backup retry after a failed backup" }, "BackupDetails": { "title": "Dictionary`2", "type": "object", "description": "Backup Status Details", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "RestoreDetails": { "title": "List`1", "type": "array", "description": "Restore Status Details", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreRestoreSingleMemberModel" } }, "SimpleResults": { "title": "List`1", "type": "array", "description": "Simple Results (such as Get backed up member names)", "nullable": true, "items": { "title": "String", "type": "string" } }, "RestoreType": { "description": "Restore type (applicable only when the action was restore)", "$ref": "#/components/schemas/BackupRestoreRestoreTypes" }, "Fixups": { "title": "List`1", "type": "array", "description": "Fixups ", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreFixupModel" } } } }, "BackupRestoreStorageModel2": { "title": "BackupRestoreStorageModel2", "type": "object", "additionalProperties": false, "properties": { "StorageInfo": { "description": "Cloud Storage definition", "nullable": true, "$ref": "#/components/schemas/BackupStorageInfo" }, "MaximumBackups": { "title": "Int32", "type": "integer", "description": "Maximum Backups", "format": "int32" }, "MaximumPinnedBackups": { "title": "Int32", "type": "integer", "description": "Maximum Pinned Backups ", "format": "int32" }, "MaximumAutoPinnedBackups": { "title": "Int32", "type": "integer", "description": "Maximum Auto-Pinned Backups ", "format": "int32" } } }, "BackupRestoreStorageRequestModel": { "title": "BackupRestoreStorageRequestModel", "allOf": [ { "$ref": "#/components/schemas/BackupRestoreStorageModel2" }, { "type": "object", "description": "Backup/Restore Blob Storage Request Model", "additionalProperties": false } ] }, "BackupRestoreStorageResponseModel": { "title": "BackupRestoreStorageResponseModel", "allOf": [ { "$ref": "#/components/schemas/BackupRestoreStorageModel2" }, { "type": "object", "description": "Backup/Restore Blob Storage Response Model", "additionalProperties": false } ] }, "BackupRestoreUpdateNotesRequestModel": { "title": "BackupRestoreUpdateNotesRequestModel", "type": "object", "description": "Backup/Restore Update Notes in History Table", "additionalProperties": false, "properties": { "Notes": { "title": "String", "type": "string", "description": "Notes to update", "nullable": true } } }, "BackupRestoreValidateStorage": { "title": "BackupRestoreValidateStorage", "type": "object", "additionalProperties": false, "properties": { "Validated": { "title": "Boolean", "type": "boolean" }, "ValidateStorageErrors": { "title": "Dictionary`2", "type": "object", "nullable": true, "x-dictionaryKey": { "$ref": "#/components/schemas/BackupRestoreValidateStorageErrors" }, "additionalProperties": { "title": "String", "type": "string" } }, "BackupRestoreStorage": { "nullable": true, "$ref": "#/components/schemas/BackupRestoreStorageModel2" } } }, "BackupRestoreValidateStorageErrors": { "title": "BackupRestoreValidateStorageErrors", "type": "string", "description": "", "x-enumNames": [ "Undefined", "Permissions", "ExpirationWarning", "Expired", "StartDateError", "SourceType", "Other" ], "enum": [ "Undefined", "Permissions", "ExpirationWarning", "Expired", "StartDateError", "SourceType", "Other" ] }, "BackupRestoreValidateStorageResponseModel": { "title": "BackupRestoreValidateStorageResponseModel", "allOf": [ { "$ref": "#/components/schemas/BackupRestoreValidateStorage" }, { "type": "object", "additionalProperties": false } ] }, "BackupStorageInfo": { "title": "BackupStorageInfo", "type": "object", "description": "Backup/Restore cloud storage definition", "additionalProperties": false, "properties": { "BlobStorageType": { "description": "Cloud storage type", "$ref": "#/components/schemas/BackupRestoreBlobStorage" }, "FileStorageFolder": { "title": "String", "type": "string", "description": "File Storage folder\n ", "nullable": true }, "Info1": { "title": "String", "type": "string", "description": "Info 1 for storage", "nullable": true }, "Info2": { "title": "String", "type": "string", "description": "Info 2 for storage", "nullable": true }, "Info3": { "title": "String", "type": "string", "description": "Info 3 for storage", "nullable": true }, "Info4": { "title": "String", "type": "string", "description": "Info 4 for storage", "nullable": true }, "Initialized": { "title": "Boolean", "type": "boolean", "description": "Storage initialized by admin" } } }, "BaseNameValueStringPairModel": { "title": "BaseNameValueStringPairModel", "type": "object", "description": "A name/value pair, with the value of (JSON) type String.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name.", "nullable": true }, "Value": { "title": "String", "type": "string", "description": "Value.", "nullable": true } } }, "BatchRequestItemModel": { "title": "BatchRequestItemModel", "type": "object", "description": "Request object for a single item in a batch request.", "additionalProperties": false, "required": [ "Reference", "RelativeUrl" ], "properties": { "Reference": { "title": "String", "type": "string", "description": "Reference. Required, and must be unique within all items in a single batch request.", "maxLength": 64, "minLength": 1, "pattern": "^[-_0-9a-zA-Z]*$", "example": "For example, 0" }, "Method": { "title": "String", "type": "string", "description": "HTTP method of the request endpoint. (GET, HEAD, PUT, PATCH, POST, DELETE)", "default": "GET", "nullable": true }, "RelativeUrl": { "title": "String", "type": "string", "description": "Relative URL of the request endpoint vs. the site root.\nMust start with the API version i.e. `\"v1/{customerid}/{siteid}/...\"`", "minLength": 1, "example": "For example, /techpreview/me" }, "Headers": { "title": "NameValueStringPairModel[]", "type": "array", "description": "List of request headers.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Body": { "title": "String", "type": "string", "description": "Request body. Optional for PUT, PATCH, and POST.\nCannot be specified for GET, HEAD, and DELETE.", "nullable": true, "example": "For example, {\"Name\":\"Tag01\",\"Description\":\"NewTag\"}" }, "Description": { "title": "String", "type": "string", "description": "Optional. Description for the request. ", "nullable": true, "example": "For example, \"Reboot Machine : [MachineName]\"" }, "ObjectCount": { "title": "Int32", "type": "integer", "description": "Number of objects being operated on in this request.\nUsed for more accurate success/fail count calculation.", "format": "int32" } } }, "BatchRequestModel": { "title": "BatchRequestModel", "type": "object", "description": "Request object for a list of items to execute in a batch request.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "BatchRequestItemModel[]", "type": "array", "description": "List of batch request items.", "items": { "$ref": "#/components/schemas/BatchRequestItemModel" } }, "BatchJobType": { "description": "Optional. Specify the job type for the batched action.", "nullable": true, "$ref": "#/components/schemas/NotifiableJobType" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Optional. Set the metadata of the batched action.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "BatchResponseItemModel": { "title": "BatchResponseItemModel", "type": "object", "description": "Response object for a single item in a batch request.", "additionalProperties": false, "required": [ "Reference", "Code" ], "properties": { "Reference": { "title": "String", "type": "string", "description": "Reference that allows connecting the response item\nto the corresponding request item.", "minLength": 1 }, "Code": { "title": "Int32", "type": "integer", "description": "HTTP status code as a result of the request.", "format": "int32" }, "Headers": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Response headers.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Body": { "title": "String", "type": "string", "description": "Response body, if one was present.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description of the request. ", "nullable": true }, "ObjectCount": { "title": "Int32", "type": "integer", "description": "Number of objects being operated on in this request.", "format": "int32" } } }, "BatchResponseModel": { "title": "BatchResponseModel", "type": "object", "description": "Response object for a batch request.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "BatchResponseItemModel[]", "type": "array", "description": "List of batch item responses.", "items": { "$ref": "#/components/schemas/BatchResponseItemModel" } }, "BatchJobType": { "title": "String", "type": "string", "description": "Job type of the batched action.", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the batched action.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "BckRstrAutoConfigComponents": { "title": "BckRstrAutoConfigComponents", "type": "string", "description": "Backup / Restore component IDs", "x-enumNames": [ "Tags", "AdminScopes", "AdminRoles", "AdminAdministrators", "HostConnections", "Icons", "AdminFolders", "MachineCatalogs", "StoreFronts", "DeliveryGroups", "ApplicationGroups", "ApplicationFolders", "Applications", "AppVServers", "AppLibPackageDiscovery", "AppVIsolationGroups", "GroupPolicies", "UserZonePreferences", "SiteData", "Zones", "BackupSchedules", "All", "Multiple", "Undefined" ], "enum": [ "Tags", "AdminScopes", "AdminRoles", "AdminAdministrators", "HostConnections", "Icons", "AdminFolders", "MachineCatalogs", "StoreFronts", "DeliveryGroups", "ApplicationGroups", "ApplicationFolders", "Applications", "AppVServers", "AppLibPackageDiscovery", "AppVIsolationGroups", "GroupPolicies", "UserZonePreferences", "SiteData", "Zones", "BackupSchedules", "All", "Multiple", "Undefined" ] }, "CatalogErrorType": { "title": "CatalogErrorType", "type": "string", "description": "Enum representing the types of errors that can occur for a machine catalog.", "x-enumNames": [ "Unknown", "GeneralError", "RecoverableBroken", "UnrecoverableBroken", "CertificateExpired" ], "enum": [ "Unknown", "GeneralError", "RecoverableBroken", "UnrecoverableBroken", "CertificateExpired" ] }, "CatalogInfo": { "title": "CatalogInfo", "type": "object", "description": "Catalog information", "additionalProperties": false, "properties": { "CatalogUid": { "title": "Int32", "type": "integer", "description": "Catalog unique identifier", "format": "int32" }, "CatalogName": { "title": "String", "type": "string", "description": "Catalog name", "nullable": true }, "AdminFolderUid": { "title": "Int32", "type": "integer", "description": "Catalog admin folder unique identifier", "format": "int32" }, "AdminFolder": { "title": "String", "type": "string", "description": "Catalog admin folder path", "nullable": true } } }, "CatalogIssueModelOfMachineCatalogWarningType": { "title": "CatalogIssueModel`1", "allOf": [ { "$ref": "#/components/schemas/IssueModelOfMachineCatalogWarningType" }, { "type": "object", "additionalProperties": false, "properties": { "Subtype": { "nullable": true, "$ref": "#/components/schemas/MachineCatalogWarningSubtype" } } } ] }, "CatalogNameCheckRequestModel": { "title": "CatalogNameCheckRequestModel", "type": "object", "description": "Request Model for Checking Catalog Name with Admin Folder", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Catalog Name with Admin Folder", "nullable": true } } }, "CatalogSearchFilterGroupRequestModel": { "title": "CatalogSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for applications", "additionalProperties": false, "properties": { "SearchFilterGroupType": { "description": "The type of search filter group", "$ref": "#/components/schemas/CatalogSearchFilterGroupType" }, "SearchFilters": { "title": "CatalogSearchFilterRequestModel[]", "type": "array", "description": "The search filters in search filter group", "nullable": true, "items": { "$ref": "#/components/schemas/CatalogSearchFilterRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/CatalogSearchFilterGroupsType" }, "SearchFilterGroups": { "title": "CatalogSearchFilterGroupRequestModel[]", "type": "array", "description": "The search filter group in search filter groups", "nullable": true, "items": { "$ref": "#/components/schemas/CatalogSearchFilterGroupRequestModel" } } } }, "CatalogSearchFilterGroupsType": { "title": "CatalogSearchFilterGroupsType", "type": "string", "description": "The search filter groups type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "CatalogSearchFilterGroupType": { "title": "CatalogSearchFilterGroupType", "type": "string", "description": "The search filter group type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "CatalogSearchFilterRequestModel": { "title": "CatalogSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for machine catalogs.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/CatalogSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true, "example": "For example, test" }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "CatalogSearchProperty": { "title": "CatalogSearchProperty", "type": "string", "description": "Machine catalog properties can be used for advanced catalog searches.", "x-enumNames": [ "Name", "FullName", "Uid", "AllocationType", "AssignedCount", "AvailableCount", "Description", "IsRemotePC", "MachinesArePhysical", "ProvisioningType", "PvsAddress", "PvsDomain", "SessionSupport", "UnassignedCount", "UsedCount", "PersistChanges", "ProvisioningSchemeId" ], "enum": [ "Name", "FullName", "Uid", "AllocationType", "AssignedCount", "AvailableCount", "Description", "IsRemotePC", "MachinesArePhysical", "ProvisioningType", "PvsAddress", "PvsDomain", "SessionSupport", "UnassignedCount", "UsedCount", "PersistChanges", "ProvisioningSchemeId" ] }, "CatalogSearchRequestModel": { "title": "CatalogSearchRequestModel", "type": "object", "description": "Request model for defining advanced machine catalog search criteria.", "additionalProperties": false, "properties": { "AdminFolder": { "title": "String", "type": "string", "description": "Admin folder in which to search for the machine catalog.", "nullable": true, "example": "Name of an admin folder" }, "IncludeSubFolders": { "title": "Boolean", "type": "boolean", "description": "Whether to include subfolders of the\nAdminFolder in the search for the\nmachine catalogs.", "default": true, "nullable": true }, "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the catalog.", "nullable": true, "example": "For example, name of a catalog" }, "SearchFilters": { "title": "CatalogSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/CatalogSearchFilterRequestModel" } }, "SortCriteria": { "description": "Sort criteria for the results.", "nullable": true, "$ref": "#/components/schemas/CatalogSortCriteriaRequestModel" }, "SearchFilterGroups": { "title": "CatalogSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/CatalogSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/CatalogSearchFilterGroupsType" }, "IssueFilterType": { "description": "Indicates the type of issue filter to apply when searching for machine catalogs.", "$ref": "#/components/schemas/IssueSearchFilterType" } } }, "CatalogSearchResponseModel": { "title": "CatalogSearchResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Name,FullName,Id,Uid,AllocationType,Description,IsPowerManaged,IsRemotePC,MachineType,MinimumFunctionalLevel,HasBeenPromoted,HasBeenPromotedFrom,PersistChanges,ProvisioningType,SessionSupport,SharingKind,Zone,AdminFolder,HypervisorVMTagging. \n Catalog Search result model\n ", "allOf": [ { "$ref": "#/components/schemas/MachineCatalogResponseModel" }, { "type": "object", "description": "Catalog Search result model", "additionalProperties": false, "properties": { "MachinesArePhysical": { "title": "Boolean", "type": "boolean", "description": "Indicates whether or not machines in the machine catalog are Physical." }, "HypervisorPluginResponse": { "description": "Hypervisor plugin info that is associated with the machines in the catalog.", "nullable": true, "$ref": "#/components/schemas/HypervisorPluginResponseModel" }, "HypervisorConnection": { "description": "The hypervisor connection that is associated with the machines in the catalog.\nThis property only applies when ProvisioningType is\nMCS OR when\nIsRemotePC is `true` and\nthe Remote PCs are configured for power management via a hypervisor. For other\nprovisioning types, machines can be from one or more different hypervisor\nconnections.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "HypervisorConnectionUid": { "title": "Int32", "type": "integer", "description": "The Uid of the hypervisor connection that is associated with the machines in the catalog.\nThis property only applies to MCS provisioned catalogs.\nFor other provisioning types machines can be from one or more different hypervisor connections.", "format": "int32" } } } ] }, "CatalogSearchResponseModelCollection": { "title": "CatalogSearchResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfCatalogSearchResponseModel" }, { "type": "object", "description": "Response object for collections of CatalogSearchResponseModel.", "additionalProperties": false } ] }, "CatalogSortCriteriaRequestModel": { "title": "CatalogSortCriteriaRequestModel", "type": "object", "description": "Catalog sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/CatalogSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "CheckObjectNameExistsRequestModel": { "title": "CheckObjectNameExistsRequestModel", "type": "object", "description": "Details of the object.", "additionalProperties": false, "required": [ "ObjectType", "NameOrPath" ], "properties": { "ObjectType": { "description": "Type of the object to check.", "example": "For example, MachineCatalog", "$ref": "#/components/schemas/ObjectType" }, "NameOrPath": { "title": "String", "type": "string", "description": "Name or path of the object to check.", "minLength": 1 } } }, "CloudHealthCheckStatus": { "title": "CloudHealthCheckStatus", "type": "string", "description": "Cloud HealthCheck Status.", "x-enumNames": [ "Unknown", "Ok", "Fail", "InvalidCommand" ], "enum": [ "Unknown", "Ok", "Fail", "InvalidCommand" ] }, "CollectionEnvelopeOfFilterDefinition": { "title": "CollectionEnvelope`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "properties": { "items": { "title": "FilterDefinition[]", "type": "array", "description": "Items in the collection.", "nullable": true, "items": { "$ref": "#/components/schemas/FilterDefinition" } }, "continuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete, and it should call the API again\nspecifying the continuation token as a query parameter.", "nullable": true }, "totalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be more than the number of items returned,\nif there is a ContinuationToken. This is returned only in the response to $search APIs.", "format": "int32", "nullable": true } } }, "CollectionEnvelopeOfFilterResponse": { "title": "CollectionEnvelope`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "properties": { "items": { "title": "FilterResponse[]", "type": "array", "description": "Items in the collection.", "nullable": true, "items": { "$ref": "#/components/schemas/FilterResponse" } }, "continuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete, and it should call the API again\nspecifying the continuation token as a query parameter.", "nullable": true }, "totalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be more than the number of items returned,\nif there is a ContinuationToken. This is returned only in the response to $search APIs.", "format": "int32", "nullable": true } } }, "CollectionEnvelopeOfPolicyResponse": { "title": "CollectionEnvelope`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "properties": { "items": { "title": "PolicyResponse[]", "type": "array", "description": "Items in the collection.", "nullable": true, "items": { "$ref": "#/components/schemas/PolicyResponse" } }, "continuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete, and it should call the API again\nspecifying the continuation token as a query parameter.", "nullable": true }, "totalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be more than the number of items returned,\nif there is a ContinuationToken. This is returned only in the response to $search APIs.", "format": "int32", "nullable": true } } }, "CollectionEnvelopeOfPolicySetResponse": { "title": "CollectionEnvelope`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "properties": { "items": { "title": "PolicySetResponse[]", "type": "array", "description": "Items in the collection.", "nullable": true, "items": { "$ref": "#/components/schemas/PolicySetResponse" } }, "continuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete, and it should call the API again\nspecifying the continuation token as a query parameter.", "nullable": true }, "totalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be more than the number of items returned,\nif there is a ContinuationToken. This is returned only in the response to $search APIs.", "format": "int32", "nullable": true } } }, "CollectionEnvelopeOfSettingResponse": { "title": "CollectionEnvelope`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "properties": { "items": { "title": "SettingResponse[]", "type": "array", "description": "Items in the collection.", "nullable": true, "items": { "$ref": "#/components/schemas/SettingResponse" } }, "continuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete, and it should call the API again\nspecifying the continuation token as a query parameter.", "nullable": true }, "totalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be more than the number of items returned,\nif there is a ContinuationToken. This is returned only in the response to $search APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfActionResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ActionResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ActionResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAdminFolderResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AdminFolderResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AdminFolderResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAdministratorResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AdministratorResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AdministratorResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAdministratorRightResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AdministratorRightResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AdministratorRightResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAdvancedAccessPolicyResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AdvancedAccessPolicyResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AdvancedAccessPolicyResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAdvisorRecommendationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AdvisorRecommendationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AdvisorRecommendationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAppLibPackageDiscoveryProfileResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AppLibPackageDiscoveryProfileResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AppLibPackageDiscoveryProfileResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAppLibPackageDiscoveryResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AppLibPackageDiscoveryResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AppLibPackageDiscoveryResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfApplicationDeliveryGroupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ApplicationDeliveryGroupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ApplicationDeliveryGroupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfApplicationFolderResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ApplicationFolderResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ApplicationFolderResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfApplicationGroupDeliveryGroupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ApplicationGroupDeliveryGroupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ApplicationGroupDeliveryGroupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfApplicationGroupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ApplicationGroupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ApplicationGroupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfApplicationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ApplicationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ApplicationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAppVApplicationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AppVApplicationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AppVApplicationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAppVIsolationGroupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AppVIsolationGroupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AppVIsolationGroupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAppVPackageResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AppVPackageResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AppVPackageResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAppVServerResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AppVServerResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AppVServerResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAutoscaleGroupPluginResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AutoscaleGroupPluginResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AutoscaleGroupPluginResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAutoscalePluginTemplateResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AutoscalePluginTemplateResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AutoscalePluginTemplateResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfAzureADSecurityGroupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "AzureADSecurityGroupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/AzureADSecurityGroupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfBackupRestoreBackupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "BackupRestoreBackupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/BackupRestoreBackupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfBackupRestoreHistoryInformation": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "BackupRestoreHistoryInformation[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/BackupRestoreHistoryInformation" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfBackupRestoreMemberResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "BackupRestoreMemberResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/BackupRestoreMemberResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfBackupRestoreScheduleModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "BackupRestoreScheduleModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/BackupRestoreScheduleModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfCatalogSearchResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "CatalogSearchResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/CatalogSearchResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfConfigurationSlotResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ConfigurationSlotResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ConfigurationSlotResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDailyCostItemResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DailyCostItemResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DailyCostItemResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDatabaseChangeScriptModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DatabaseChangeScriptModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DatabaseChangeScriptModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDatabaseResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DatabaseResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DatabaseResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDeliveryControllerDeleteScriptModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DeliveryControllerDeleteScriptModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DeliveryControllerDeleteScriptModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDeliveryControllerResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DeliveryControllerResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DeliveryControllerResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDeliveryGroupAssociationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DeliveryGroupAssociationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DeliveryGroupAssociationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDeliveryGroupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DeliveryGroupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DeliveryGroupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDesktopResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DesktopResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DesktopResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfDesktopUsageResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "DesktopUsageResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/DesktopUsageResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfEnrollmentResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "EnrollmentResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/EnrollmentResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfFtaResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "FtaResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/FtaResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfHypervisorMachineCatalogResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "HypervisorMachineCatalogResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/HypervisorMachineCatalogResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfHypervisorPluginResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "HypervisorPluginResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/HypervisorPluginResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfHypervisorResourcePoolDetailResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "HypervisorResourcePoolDetailResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfHypervisorResourcePoolNetworkResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "HypervisorResourcePoolNetworkResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/HypervisorResourcePoolNetworkResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfHypervisorResourceResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "HypervisorResourceResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/HypervisorResourceResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfHypervisorResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "HypervisorResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/HypervisorResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfHypervisorsAndResourcePoolsResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "HypervisorsAndResourcePoolsResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/HypervisorsAndResourcePoolsResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfHypervisorVmValidationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "HypervisorVmValidationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/HypervisorVmValidationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIconResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IconResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IconResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIdentityContainerResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IdentityContainerResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IdentityContainerResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIdentityDirectoryResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IdentityDirectoryResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IdentityDirectoryResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIdentityDomainResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IdentityDomainResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IdentityDomainResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIdentityForestResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IdentityForestResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IdentityForestResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIdentityMachineResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IdentityMachineResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IdentityMachineResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIdentityPrinterResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IdentityPrinterResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IdentityPrinterResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIdentitySiteResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IdentitySiteResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IdentitySiteResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfIdentityUserResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfImageDefinitionResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ImageDefinitionResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ImageDefinitionResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfImageDefinitionsAndImageVersionsResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ImageDefinitionsAndImageVersionsResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ImageDefinitionsAndImageVersionsResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfImageVersionProvisioningSchemeRefResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ImageVersionProvisioningSchemeRefResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ImageVersionProvisioningSchemeRefResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfImageVersionResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ImageVersionResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ImageVersionResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfImportProvisionedVirtualMachineResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ImportProvisionedVirtualMachineResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ImportProvisionedVirtualMachineResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfJobResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "JobResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/JobResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfLicenseEntitlementResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "LicenseEntitlementResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/LicenseEntitlementResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfLicenseResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "LicenseResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/LicenseResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfLicensingUserResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "LicensingUserResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/LicensingUserResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfLogOperationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "LogOperationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/LogOperationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfLowLevelOperationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "LowLevelOperationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/LowLevelOperationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfMachineApplicationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "MachineApplicationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/MachineApplicationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfMachineCatalogResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "MachineCatalogResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/MachineCatalogResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfMachineConfigurationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "MachineConfigurationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/MachineConfigurationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfMachineIdentityPoolResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "MachineIdentityPoolResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/MachineIdentityPoolResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfMachineResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "MachineResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/MachineResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfNameValueStringPairModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "NameValueStringPairModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPowerActionScheduleResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PowerActionScheduleResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PowerActionScheduleResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPowerShellHistoryResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PowerShellHistoryResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PowerShellHistoryResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPowerTimeSchemeResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PowerTimeSchemeResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PowerTimeSchemeResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPredefinedPermissionGroupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PredefinedPermissionGroupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PredefinedPermissionGroupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPredefinedPermissionResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PredefinedPermissionResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PredefinedPermissionResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisionedBackupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisionedBackupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisionedBackupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisionedVirtualMachineConfigurationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisionedVirtualMachineConfigurationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineConfigurationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisionedVirtualMachineSearchResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisionedVirtualMachineSearchResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisionedVirtualMachineVersionResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisionedVirtualMachineVersionResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineVersionResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisioningOperationEventSearchResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisioningOperationEventSearchResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisioningOperationEventSearchResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisioningSchemeConfigurationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisioningSchemeConfigurationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisioningSchemeConfigurationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisioningSchemeMachineAccountResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisioningSchemeMachineAccountResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisioningSchemeMachineAccountResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisioningSchemeResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisioningSchemeResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisioningSchemeResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfProvisioningSchemeSearchResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ProvisioningSchemeSearchResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ProvisioningSchemeSearchResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPvsCollectionResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PvsCollectionResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PvsCollectionResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPvsDeviceResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PvsDeviceResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PvsDeviceResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPvsSiteResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PvsSiteResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PvsSiteResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPvsStreamingSiteResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PvsStreamingSiteResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PvsStreamingSiteResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPvsStreamingStoreResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PvsStreamingStoreResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PvsStreamingStoreResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfPvsStreamingVDiskResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "PvsStreamingVDiskResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/PvsStreamingVDiskResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfRebootScheduleResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "RebootScheduleResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/RebootScheduleResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfRecommendationModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "RecommendationModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/RecommendationModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfResourceAccessPolicyResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ResourceAccessPolicyResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ResourceAccessPolicyResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfResourceCostItemResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ResourceCostItemResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ResourceCostItemResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfRoleResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "RoleResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/RoleResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfScheduleResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ScheduleResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ScheduleResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfScopedObjectResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ScopedObjectResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ScopedObjectResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfScopeResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ScopeResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfServiceAccountResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ServiceAccountResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ServiceAccountResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfSessionResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "SessionResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/SessionResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfSessionTrendItem": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "SessionTrendItem[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/SessionTrendItem" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfSiteResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "SiteResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/SiteResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfStartMenuApplicationResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "StartMenuApplicationResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/StartMenuApplicationResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfStoreFrontDeliveryGroupResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "StoreFrontDeliveryGroupResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/StoreFrontDeliveryGroupResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfStoreFrontServerResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "StoreFrontServerResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/StoreFrontServerResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfTagResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "TagResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/TagResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfTaskResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "TaskResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/TaskResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfTaskSubJobResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "TaskSubJobResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/TaskSubJobResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfTenantResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "TenantResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/TenantResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfTimeZoneResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "TimeZoneResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/TimeZoneResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfUpgradePackageVersionResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "UpgradePackageVersionResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/UpgradePackageVersionResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfUserZonePreferenceResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "UserZonePreferenceResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/UserZonePreferenceResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfVMImageResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "VMImageResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/VMImageResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfZonedItemResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ZonedItemResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ZonedItemResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "CollectionModelOfZoneResponseModel": { "title": "CollectionModel`1", "type": "object", "description": "Response object for collections of items.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "ZoneResponseModel[]", "type": "array", "description": "List of items.", "items": { "$ref": "#/components/schemas/ZoneResponseModel" } }, "ContinuationToken": { "title": "String", "type": "string", "description": "If present, indicates to the caller that the query was not complete,\nand they should call the API again specifying the continuation token\nas a query parameter.", "nullable": true }, "TotalItems": { "title": "Int32", "type": "integer", "description": "Indicates the total number of items in the collection, which may be\nmore than the number of Items returned, if there is a\nContinuationToken. Only returned in the response to `$search` APIs.", "format": "int32", "nullable": true } } }, "ColorDepth": { "title": "ColorDepth", "type": "string", "description": "Color depth of HDX session.", "x-enumNames": [ "Unknown", "FourBit", "EightBit", "SixteenBit", "TwentyFourBit" ], "enum": [ "Unknown", "FourBit", "EightBit", "SixteenBit", "TwentyFourBit" ] }, "ComparisonResponseContract": { "title": "ComparisonResponseContract", "type": "object", "description": "Comparison report/result.", "additionalProperties": false, "properties": { "Targets": { "title": "String[]", "type": "array", "description": "A target is either a policy or template. This list stores the target names.", "nullable": true, "items": { "title": "String", "type": "string" } }, "Result": { "title": "ComparisonRowContract[]", "type": "array", "description": "Rows in the report.", "nullable": true, "items": { "$ref": "#/components/schemas/ComparisonRowContract" } }, "WithDefaults": { "title": "Boolean", "type": "boolean", "description": "If true, first column is setting default values." } } }, "ComparisonRowContract": { "title": "ComparisonRowContract", "type": "object", "description": "A row in a comparison report.", "additionalProperties": false, "properties": { "SettingName": { "title": "String", "type": "string", "description": "Can be either a category name or setting name.", "nullable": true }, "IsSetting": { "title": "Boolean", "type": "boolean", "description": "Indicate if SettingName is a setting name or category name." }, "IsDifferent": { "title": "Boolean", "type": "boolean", "description": "Valid only when IsSetting is false. Used to indicate if there is any difference\namong the settings in the category." }, "IsInUse": { "title": "Boolean[]", "type": "array", "description": "There are Targets.Length number of items in the list, stored in the same order as the\nitems in Targets. Value is true if the setting is configured in the target. Value is\ntrue if SettingName is a category name and at least one of the settings under the\ncategory has IsInUse set to true.", "nullable": true, "items": { "title": "Boolean", "type": "boolean" } }, "Values": { "title": "String[]", "type": "array", "description": "There are Targets.Length number of items in the list, stored in the same order as the\nitems in Targets. Value should not be used if the corresponding IsInUse value is false.\nIf the IsInUse value is false, a - should be displayed if IsSetting is true. Don't use\nthe values here if IsSetting is false.", "nullable": true, "items": { "title": "String", "type": "string" } }, "Category": { "title": "String", "type": "string", "description": "For internal use to keep track of setting category.", "nullable": true }, "DefaultValue": { "title": "String", "type": "string", "description": "The default value as specified in the GPFX file for the setting.", "nullable": true } } }, "ConfigurationSlotResponseModel": { "title": "ConfigurationSlotResponseModel", "type": "object", "description": "Configuration Slot response class.", "additionalProperties": false, "properties": { "Id": { "title": "Int32", "type": "integer", "description": "The Id of a configuration slot.", "format": "int32" }, "Name": { "title": "String", "type": "string", "description": "The name of a configuration slot.", "nullable": true }, "SettingsGroup": { "title": "String", "type": "string", "description": "The SettingsGroup of a configuration slot.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The Description of a configuration slot.", "nullable": true } } }, "ConfigurationSlotResponseModelCollection": { "title": "ConfigurationSlotResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfConfigurationSlotResponseModel" }, { "type": "object", "description": "Collection of ConfigurationSlotResponseModel", "additionalProperties": false } ] }, "ConnectionFailureReason": { "title": "ConnectionFailureReason", "type": "string", "description": "The reason why the last connection failure occurred.", "x-enumNames": [ "Unknown", "None", "SessionPreparation", "RegistrationTimeout", "ConnectionTimeout", "Licensing", "Ticketing", "Other" ], "enum": [ "Unknown", "None", "SessionPreparation", "RegistrationTimeout", "ConnectionTimeout", "Licensing", "Ticketing", "Other" ] }, "ConnectionMode": { "title": "ConnectionMode", "type": "string", "description": "Modes in which a connection can be established to a session host.", "x-enumNames": [ "Unknown", "Brokered", "Unbrokered", "LeasedConnection", "VdaHighAvailabilityMode", "ThirdPartyBroker", "ThirdPartyBrokerWithLicensing" ], "enum": [ "Unknown", "Brokered", "Unbrokered", "LeasedConnection", "VdaHighAvailabilityMode", "ThirdPartyBroker", "ThirdPartyBrokerWithLicensing" ] }, "ContainerMetadataModel": { "title": "ContainerMetadataModel", "type": "object", "description": "About model of Container metadata for machine.\n ", "additionalProperties": false, "properties": { "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ContainerType": { "description": "Indicates if the current environment is cloud.", "$ref": "#/components/schemas/ContainerMetadataType" } } }, "ContainerMetadataType": { "title": "ContainerMetadataType", "type": "string", "description": "The type of a container, relevant to delegated administration.", "x-enumNames": [ "Unknown", "DeliveryGroup", "MachineCatalog" ], "enum": [ "Unknown", "DeliveryGroup", "MachineCatalog" ] }, "ContainerScopeResponseModel": { "title": "ContainerScopeResponseModel", "type": "object", "description": "Response object for delegated admin container scopes.", "additionalProperties": false, "required": [ "Scopes", "ScopeType" ], "properties": { "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "List of delegated admin scopes.", "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "ScopeType": { "description": "Type of the container providing the scopes.", "$ref": "#/components/schemas/ContainerScopeType" } } }, "ContainerScopeType": { "title": "ContainerScopeType", "type": "string", "description": "The type of a container, relevant to delegated administration.", "x-enumNames": [ "Unknown", "DeliveryGroup", "ApplicationGroup", "MachineCatalog", "HypervisorConnection" ], "enum": [ "Unknown", "DeliveryGroup", "ApplicationGroup", "MachineCatalog", "HypervisorConnection" ] }, "ControllerServiceStatus": { "title": "ControllerServiceStatus", "type": "string", "description": "", "x-enumNames": [ "Stopped", "DBUnconfigured", "DBRejectedConnection", "InvalidDBConfigured", "DBNotFound", "DBMissingOptionalFeature", "DBMissingMandatoryFeature", "DBNewerVersionThanService", "DBOlderVersionThanService", "DBVersionChangeInProgress", "OK", "PendingFailure", "Failed", "Unknown", "ServiceNotInSiteDB", "InvalidDBConnectionString", "PendingServiceDiscovery", "PendingServiceRegistration", "PendingConfiguration" ], "enum": [ "Stopped", "DBUnconfigured", "DBRejectedConnection", "InvalidDBConfigured", "DBNotFound", "DBMissingOptionalFeature", "DBMissingMandatoryFeature", "DBNewerVersionThanService", "DBOlderVersionThanService", "DBVersionChangeInProgress", "OK", "PendingFailure", "Failed", "Unknown", "ServiceNotInSiteDB", "InvalidDBConnectionString", "PendingServiceDiscovery", "PendingServiceRegistration", "PendingConfiguration" ] }, "ControllerServiceType": { "title": "ControllerServiceType", "type": "string", "description": "FMA service types on controller service.", "x-enumNames": [ "Unknown", "Broker", "Acct", "Prov", "Hyp", "Lic", "Pvs", "Monitor", "Sf", "EnvTest", "Orch", "Trust", "AppV", "Vus", "Config", "Log", "Analytics", "Admin", "AppLib" ], "enum": [ "Unknown", "Broker", "Acct", "Prov", "Hyp", "Lic", "Pvs", "Monitor", "Sf", "EnvTest", "Orch", "Trust", "AppV", "Vus", "Config", "Log", "Analytics", "Admin", "AppLib" ] }, "CopyPoliciesRequest": { "title": "CopyPoliciesRequest", "type": "object", "description": "Data for copying policies to other policy sets.", "additionalProperties": false, "properties": { "policyGuids": { "title": "Guid[]", "type": "array", "description": "GUIDs of some of the policies of a policy set.", "nullable": true, "items": { "title": "Guid", "type": "string", "format": "guid" } }, "toPolicySets": { "title": "Guid[]", "type": "array", "description": "GUIDs of the destination policy sets.", "nullable": true, "items": { "title": "Guid", "type": "string", "format": "guid" } } } }, "CpuPriorityLevel": { "title": "CpuPriorityLevel", "type": "string", "description": "Starting process priority level for an application.", "x-enumNames": [ "Unknown", "Low", "BelowNormal", "Normal", "AboveNormal", "High" ], "enum": [ "Unknown", "Low", "BelowNormal", "Normal", "AboveNormal", "High" ] }, "CreateAdminAdministratorRequestModel": { "title": "CreateAdminAdministratorRequestModel", "type": "object", "description": "Model for adding an administrator", "additionalProperties": false, "properties": { "User": { "title": "String", "type": "string", "description": "The administrator to add.", "nullable": true }, "Rights": { "title": "AdminRightRequestModel[]", "type": "array", "description": "Rights associated with the administrator. It is ok if there is no rights specified.", "nullable": true, "items": { "$ref": "#/components/schemas/AdminRightRequestModel" } }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the administrator is enabled. Disabled\nadministrators cannot administer the site unless they are a member\nof a different user group which is granted access by a different\nadministrator record.", "default": true, "nullable": true } } }, "CreateAdminFolderRequestModel": { "title": "CreateAdminFolderRequestModel", "type": "object", "description": "Request object for creating an admin folder.", "additionalProperties": false, "required": [ "Name", "ObjectIdentifiers" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the folder to create.\nMay be omitted if Path is used;\notherwise required.\n\nIf both and \nare specified, a folder with the specified name\nwill be created as a child of the specified path.", "minLength": 1, "example": "Name of the admin folder" }, "Path": { "title": "String", "type": "string", "description": "Path where the folder should be created.\nExclusive with ParentId. One or the\nother property may be used but not both.\n\nPath to where the folder should be created.\nAny folders in the path which don't exist will\nbe created.\n\nIf not specified, default is the root folder path.", "nullable": true, "example": "Path to the admin folder" }, "ParentId": { "title": "String", "type": "string", "description": "Parent folder where the folder should be created.\nExclusive with Path. One or the\nother property may be used but not both.\n\nIf not specified, default is the root folder path.", "nullable": true, "example": "Id of the parent folder" }, "ObjectIdentifiers": { "title": "AdminFolderObjectIdentifier[]", "type": "array", "description": "The object identifiers of the new admin folder. To indicated what objects this folder will include.", "items": { "$ref": "#/components/schemas/AdminFolderObjectIdentifier" } } } }, "CreateAdminRoleRequestModel": { "title": "CreateAdminRoleRequestModel", "type": "object", "description": "Request object for creation of admin scope.", "additionalProperties": false, "required": [ "Name" ], "properties": { "Name": { "title": "String", "type": "string", "description": "The name of the role. Name is globally unique.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "The description of the admin role.", "nullable": true }, "CanLaunchManage": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the role has access to the Manage tab in Citrix Cloud.", "nullable": true }, "CanLaunchMonitor": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the role has access to the Monitor tab in Citrix Cloud.", "nullable": true }, "Permissions": { "title": "String[]", "type": "array", "description": "List of permissions granted by the role. At least one permission is required.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "CreateAdminScopeRequestModel": { "title": "CreateAdminScopeRequestModel", "type": "object", "additionalProperties": false, "required": [ "Name" ], "properties": { "Name": { "title": "String", "type": "string", "description": "The name of the scope. Name is globally unique.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "The description of the admin scope.", "nullable": true }, "IsTenantScope": { "title": "Boolean", "type": "boolean", "description": "Indicates if it is tenant scope." }, "ScopedObjects": { "title": "ScopedObjectRequestModel[]", "type": "array", "description": "Scoped objects associated with the scope object.", "nullable": true, "items": { "$ref": "#/components/schemas/ScopedObjectRequestModel" } } } }, "CreateApplicationFolderRequestModel": { "title": "CreateApplicationFolderRequestModel", "type": "object", "description": "Request object for creating an application folder.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the folder to create.\nMay be omitted if Path is used;\notherwise required.\n\nIf both and \nare specified, a folder with the specified name\nwill be created as a child of the specified path.", "nullable": true, "example": "Name of the application folder" }, "Path": { "title": "String", "type": "string", "description": "Path where the folder should be created.\nExclusive with ParentId. One or the\nother property may be used but not both.\n\nPath to where the folder should be created.\nAny folders in the path which don't exist will\nbe created.\n\nIf not specified, default is the root folder path.", "nullable": true, "example": "Path to the application folder" }, "ParentId": { "title": "String", "type": "string", "description": "Parent folder where the folder should be created.\nExclusive with Path. One or the\nother property may be used but not both.\n\nIf not specified, default is the root folder path.", "nullable": true, "example": "Id of the parent folder" } } }, "CreateApplicationGroupRequestModel": { "title": "CreateApplicationGroupRequestModel", "type": "object", "description": "Request body for creating an application group.\n ", "additionalProperties": false, "required": [ "Name" ], "properties": { "AdminFolder": { "title": "String", "type": "string", "description": "The admin folder in which the application group\nshould be created.", "nullable": true, "example": "Path or Id of the admin folder" }, "Name": { "title": "String", "type": "string", "description": "Name of the application group to create.", "maxLength": 64, "minLength": 1, "example": "Name of the application group" }, "Description": { "title": "String", "type": "string", "description": "Description of the application group.", "maxLength": 512, "nullable": true, "example": "Description of the application group" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the application group's applications can be launched by end users.", "default": true, "nullable": true }, "RestrictToTag": { "title": "String", "type": "string", "description": "Optional tag that may be used further to restrict which machines may be used\nfor launching the application group's applications.\n\n\nA machine may be used by an application group if either the application group has\nno tag restriction or the application group does have a tag restriction and\nthe machine is tagged with the same tag.", "nullable": true, "example": "Name or Id of a tag" }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the newly created application group will\nbe a part of.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenant(s) to associate the application group with.", "nullable": true, "example": [ "Name of a tenant" ], "items": { "title": "String", "type": "string" } }, "SessionSharingEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether the application group's applications can share sessions with\napplications that are not a member of this application group.", "default": true, "nullable": true }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery groups' access\npolic(ies) is implicitly granted access to the applications\nwithin the application group.", "default": false, "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the included users filter of the application group; that is,\nthe users and groups who are explicitly granted access to the\napplications in the application group.", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } }, "DeliveryGroups": { "title": "PriorityRefRequestModel[]", "type": "array", "description": "List of delivery groups to associate with the application group.", "nullable": true, "items": { "$ref": "#/components/schemas/PriorityRefRequestModel" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the new application group.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "CreateApplicationRequestModel": { "title": "CreateApplicationRequestModel", "type": "object", "description": "Request object for creating a published application.", "additionalProperties": false, "required": [ "Name" ], "properties": { "ApplicationFolder": { "title": "String", "type": "string", "description": "The application folder in which the application\nshould be created.", "nullable": true, "example": "Name of the application folder" }, "ApplicationType": { "description": "Specifies the type of the application.", "default": "HostedOnDesktop", "nullable": true, "$ref": "#/components/schemas/ApplicationType" }, "PackagedApplicationType": { "description": "Specifies the type of the packaged application.", "default": "NotApplicable", "nullable": true, "$ref": "#/components/schemas/PackagedApplicationType" }, "PackagedApplicationVisibility": { "description": "Specifies the resources (Workspace and/or Desktop session) where packaged application will be visible", "default": "WorkspaceAndDesktop", "nullable": true, "$ref": "#/components/schemas/PackagedApplicationVisibility" }, "BrowserName": { "title": "String", "type": "string", "description": "Internal name of the application.", "nullable": true, "example": "For example, NewBrowser" }, "ClientFolder": { "title": "String", "type": "string", "description": "Specifies the folder that the application belongs to as the user sees it.", "nullable": true, "example": "Name of the client folder" }, "CpuPriorityLevel": { "description": "Specifies the CPU priority for the launched process.", "default": "Normal", "nullable": true, "$ref": "#/components/schemas/CpuPriorityLevel" }, "ApplicationGroups": { "title": "String[]", "type": "array", "description": "Specifies one or more application groups which the application will\nbe published to.", "nullable": true, "example": [ "Name of an application group" ], "items": { "title": "String", "type": "string" } }, "Description": { "title": "String", "type": "string", "description": "Specifies the description of the application.", "nullable": true, "example": "Description of the application" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether or not this application can be launched.", "default": true, "nullable": true }, "DoNotEnumerate": { "title": "Boolean", "type": "boolean", "description": "Indicates whether or not this application is enumerable", "default": false, "nullable": true }, "HomeZone": { "title": "String", "type": "string", "description": "Specifies a home zone preference used when launching this\napplication.", "nullable": true, "example": "For example, Primary" }, "HomeZoneMode": { "description": "Specifies the zone preference mode for application launches.\nCannot be set for ApplicationType PublishedContent\nPrefer: Same as HomeZoneOnly=false, requires HomeZoneId != null\nOnly: Same as HomeZoneOnly=true, requires HomeZoneId != null\nIgnore: Same as HomeZoneOnly=false, IgnoreUserHomeZone=true, requires HomeZoneId == null\nUser: Same as HomeZoneOnly=false, IgnoreUserHomeZone=false, requires HomeZoneId == null", "default": "User", "nullable": true, "$ref": "#/components/schemas/HomeZoneMode" }, "Icon": { "title": "String", "type": "string", "description": "Icon to use for the application.", "nullable": true, "example": "Data of the icon" }, "IconFromClient": { "title": "Boolean", "type": "boolean", "description": "Specifies Whether the Icon is from client or not.\nOnly can be set to `true` if Application Type is InstalledOnClient", "default": false, "nullable": true }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery group's access\npolic(ies) is implicitly granted access to the application.", "default": false, "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the included users filter of the application; that is,\nthe users and groups who are explicitly granted access to the\npublished application.", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } }, "InstalledAppProperties": { "description": "Properties of applications that are installed on servers\nor clients.", "nullable": true, "$ref": "#/components/schemas/CreateInstalledAppRequestModel" }, "PackagedAppProperties": { "description": "Properties of applications that are delivered from application packages.", "nullable": true, "$ref": "#/components/schemas/AppVAppRequestModel" }, "AppVAppProperties": { "description": "Properties of applications that are delivered from application packages.\nIncluded for backwards compatibility with Studio", "nullable": true, "$ref": "#/components/schemas/AppVAppRequestModel" }, "ContentLocation": { "title": "String", "type": "string", "description": "Location of published content.", "nullable": true, "example": "Url to the published content" }, "MaxPerUserInstances": { "title": "Int32", "type": "integer", "description": "Specifies the maximum allowed concurrently running instances of\nthe application that an individual user can have.", "format": "int32", "default": 0, "nullable": true }, "MaxTotalInstances": { "title": "Int32", "type": "integer", "description": "Specifies the maximum allowed total of concurrently running\ninstances of the application within the site.", "format": "int32", "default": 0, "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Specifies the name of the application.", "minLength": 1, "example": "For example, notepad++" }, "PublishedName": { "title": "String", "type": "string", "description": "The name seen by end users who have access to the application.", "nullable": true, "example": "For example, notepad++" }, "ShortcutAddedToDesktop": { "title": "Boolean", "type": "boolean", "description": "Specifies whether or not a shortcut to the application\nshould be placed on the user device.", "default": false, "nullable": true }, "ShortcutAddedToStartMenu": { "title": "Boolean", "type": "boolean", "description": "Specifies whether or not a shortcut to the application\nshould be placed in the user's start menu on their user device.", "default": false, "nullable": true }, "StartMenuFolder": { "title": "String", "type": "string", "description": "Specifies the name of the start menu folder that holds\nthe application shortcut (if any).", "nullable": true, "example": "For example, C:\\" }, "Visible": { "title": "Boolean", "type": "boolean", "description": "Specifies whether or not this application is visible to users.", "default": true, "nullable": true }, "WaitForPrinterCreation": { "title": "Boolean", "type": "boolean", "description": "Specifies whether or not the session waits for the printers to\nbe created before allowing the user to interact with the session.", "default": false, "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the new application.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "FileTypes": { "title": "FtaRequestModel[]", "type": "array", "description": "The configured file type associations of the new application.", "nullable": true, "items": { "$ref": "#/components/schemas/FtaRequestModel" } } } }, "CreateAppVIsolationGroupRequestModel": { "title": "CreateAppVIsolationGroupRequestModel", "type": "object", "description": "Request object for an App-V IsolationGroup.", "additionalProperties": false, "required": [ "LibraryUid", "Name" ], "properties": { "LibraryUid": { "title": "Int32", "type": "integer", "description": "LibraryUid of IsolationGroup", "format": "int32" }, "Name": { "title": "String", "type": "string", "description": "Name of IsolationGroup", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of IsolationGroup", "nullable": true }, "IncludedAppVPackages": { "title": "AppVIsolationGroupPackageRequestModel[]", "type": "array", "description": "Included AppV packages", "nullable": true, "items": { "$ref": "#/components/schemas/AppVIsolationGroupPackageRequestModel" } } } }, "CreateAutoscaleGroupPluginRequestModel": { "title": "CreateAutoscaleGroupPluginRequestModel", "type": "object", "description": "Create a new autoscale group plugin.", "additionalProperties": false, "required": [ "Name", "Type" ], "properties": { "Name": { "title": "String", "type": "string", "description": "The name of the group plugin. Required.", "maxLength": 64, "minLength": 1 }, "Type": { "description": "Autoscale plugin type. Required, and acts as the discriminator for\ndetermining which subclass to use.", "$ref": "#/components/schemas/AutoscalePluginType" }, "Priority": { "title": "Int32", "type": "integer", "description": "The priority of this group plugin with respect to other group plugins associated with the same desktop group.\nPriority 1 is the highest priority. Optional.", "format": "int32", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the group plugin is enabled. Optional.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Optional description of the group plugin.", "nullable": true }, "AutoApprove": { "title": "Boolean", "type": "boolean", "description": "If True, indicates that any schedule override produced by the plugin is automatically accepted as the schedule for the target date. Otherwise the\nschedule is only accepted if the target date is on or before the date specified in ApprovedUntil. If AutoApprove is False and the ApprovedUntil date is\nnot set, or is in the past, then any schedule override produced is discarded without being used. Optional.", "nullable": true }, "Dates": { "title": "String[]", "type": "array", "description": "Date range for the autoscale holiday plugin (yyyy-MM-dd format). Required.", "items": { "title": "String", "type": "string" } }, "OverrideTimeSchemeUid": { "title": "Int32", "type": "integer", "description": "A power time scheme UID to use for holiday days. Optional.", "format": "int32", "nullable": true }, "PerformanceTarget": { "title": "Int32", "type": "integer", "description": "The performance target percentage for the Intelligent plugin. Required.\nValid range: 1-100.", "format": "int32", "maximum": 100.0, "minimum": 1.0 } } }, "CreateAutoscalePluginTemplateRequestModel": { "title": "CreateAutoscalePluginTemplateRequestModel", "type": "object", "description": "New autoscale plugin template request model", "additionalProperties": false, "required": [ "Name" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Autoscale plugin template name.", "maxLength": 64, "minLength": 1 }, "Dates": { "title": "String[]", "type": "array", "description": "Date range for the autoscale holiday plugin template.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "CreateConfigurationSlotRequestModel": { "title": "CreateConfigurationSlotRequestModel", "type": "object", "description": "Request object for creating a configuration slot.", "additionalProperties": false, "required": [ "Name", "SettingsGroup" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the configuration slot to create.", "maxLength": 64, "minLength": 1, "example": "SecureBrowser" }, "SettingsGroup": { "title": "String", "type": "string", "description": "Settings group of configuration slot to create.", "maxLength": 512, "minLength": 1, "example": "G=SecureBrowser" }, "Description": { "title": "String", "type": "string", "description": "Description of configuration slot to create.", "maxLength": 512, "nullable": true } } }, "CreateDeliveryGroupRequestModel": { "title": "CreateDeliveryGroupRequestModel", "type": "object", "description": "Request object for creation of delivery groups.", "additionalProperties": false, "required": [ "Name" ], "properties": { "AdminFolder": { "title": "String", "type": "string", "description": "The admin folder in which the delivery group\nshould be created.", "nullable": true, "example": "Path or Id of the admin folder" }, "Applications": { "description": "List of applications to publish on the delivery group.", "nullable": true, "$ref": "#/components/schemas/DeliveryGroupAddApplicationsRequestModel" }, "UserManagement": { "description": "Indicates whether users are managed in the Citrix Cloud Library, or\nwithin Studio.", "default": "Studio", "nullable": true, "$ref": "#/components/schemas/UserManagementModel" }, "DeliveryType": { "description": "Type of resources that may be delivered from the delivery group.", "nullable": true, "$ref": "#/components/schemas/DeliveryKind" }, "Description": { "title": "String", "type": "string", "description": "A description for this delivery group useful for administrators\nof the site.", "maxLength": 512, "pattern": "(.*)*", "nullable": true, "example": "Description of the delivery group" }, "Desktops": { "title": "DesktopRequestModel[]", "type": "array", "description": "List of desktop resources to publish on the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/DesktopRequestModel" } }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group should be in the enabled state; all\nresources published on disabled delivery groups do not appear\nto users.", "default": true, "nullable": true }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group should be created in maintenance mode;\na delivery group in maintenance mode will not allow users to\nconnect or reconnect to machines in the delivery group.", "default": false, "nullable": true }, "MachineCatalogs": { "title": "DeliveryGroupAddMachinesRequestModel[]", "type": "array", "description": "List of machine catalogs from which to assign machines to\nthe newly created delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/DeliveryGroupAddMachinesRequestModel" } }, "SessionSupport": { "description": "Optional, specifies whether machines in the delivery group are single or multi-session capable,\nDefault comes from the machine catalog, only needs to be specified when creating a delivery group without machine catalog.", "nullable": true, "$ref": "#/components/schemas/SessionSupport" }, "SharingKind": { "description": "Optional, the kind of desktops this group will hold. Valid values are Private and Shared,\nDefault comes from the machine catalog, only needs to be specified when creating a delivery group without machine catalog.", "nullable": true, "$ref": "#/components/schemas/SharingKind" }, "IsRemotePC": { "title": "Boolean", "type": "boolean", "description": "Optional, specifies whether this is to be a Remote PC delivery group.\nDefault comes from the machine catalog, only needs to be specified when creating a delivery group without machine catalog.", "nullable": true }, "MinimumFunctionalLevel": { "description": "The minimum functional level required for machines to work\nsuccessfully in the delivery group.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "Name": { "title": "String", "type": "string", "description": "The name of the new delivery group.", "minLength": 1, "example": "Name of the delivery group" }, "RequireUserHomeZone": { "title": "Boolean", "type": "boolean", "description": "Whether to require the resources from this delivery group to\nlaunch within the user's home zone.", "default": false, "nullable": true }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the newly created delivery group\nwill be a part of.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenant(s) to associate the delivery group with.", "nullable": true, "example": [ "Name of a tenant" ], "items": { "title": "String", "type": "string" } }, "AppProtectionKeyLoggingRequired": { "title": "Boolean", "type": "boolean", "description": "Specifies whether key logging app protection is required.", "nullable": true }, "AppProtectionScreenCaptureRequired": { "title": "Boolean", "type": "boolean", "description": "Specifies whether screen capture app protection is required.", "nullable": true }, "AppAccessPolicy": { "description": "Policy controlling access to all applications delivered from a\ndelivery group.", "nullable": true, "$ref": "#/components/schemas/AppAccessPolicyRequestModel" }, "AutomaticPowerOnForAssigned": { "title": "Boolean", "type": "boolean", "description": "Whether assigned (Private)\nmachines in the delivery group should be automatically\npowered-on at the start of peak time periods.", "nullable": true }, "AutomaticPowerOnForAssignedDuringPeak": { "title": "Boolean", "type": "boolean", "description": "Whether assigned (Private)\nmachines in the delivery group should be automatically\npowered-on throughout peak time periods.", "nullable": true }, "AutoScaleEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether auto-scale is enabled for the delivery group.", "nullable": true }, "RestrictAutoscaleTag": { "title": "String", "type": "string", "description": "Specifies the tag used to restrict autoscale.", "nullable": true }, "ColorDepth": { "description": "Specifies the color depth that the ICA session should use\nfor connections to machines in this group.", "default": "TwentyFourBit", "nullable": true, "$ref": "#/components/schemas/ColorDepth" }, "DefaultDesktopIcon": { "title": "String", "type": "string", "description": "Default icon to use for desktops published from the delivery group.", "maxLength": 1000000, "pattern": "UNKNOWN", "nullable": true, "example": "Data of the icon" }, "DefaultDesktopPublishedName": { "title": "String", "type": "string", "description": "Default published name to use for desktops published from the\ndelivery group.", "nullable": true, "example": "For example, testDesktop" }, "HdxSslEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether connections to machines in the delivery group will\nuse SSL.", "default": false, "nullable": true }, "LingerSettings": { "description": "Session linger settings for sessions launched on machines\nin the delivery group.", "nullable": true, "$ref": "#/components/schemas/FastApplicationSettingsRequestModel" }, "OffPeakBufferSizePercent": { "title": "Int32", "type": "integer", "description": "The percentage of machines in the delivery group that should be kept\navailable in an idle state outside peak hours.", "format": "int32", "default": 0, "maximum": 100.0, "minimum": 0.0, "nullable": true }, "OffPeakDisconnectAction": { "description": "The action to be performed after a configurable period of a user\nsession disconnecting outside peak hours.", "default": "Nothing", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session disconnects outside peak hours.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "OffPeakExtendedDisconnectAction": { "description": "The action to be performed after a second configurable period of a\nuser session disconnecting outside peak hours.", "default": "Nothing", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakExtendedDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the second configured action should be\nperformed after a user session disconnects outside peak hours.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "OffPeakLogOffAction": { "description": "The action to be performed after a configurable period of a user\nsession ending outside peak hours.", "default": "Nothing", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakLogOffTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session ends outside peak hours.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LimitSecondsToForceLogOffUserDuringPeak": { "title": "Int32", "type": "integer", "description": "Represents the number of seconds that must elapsed before\nthe active sessions on the draining machines belonging to\nthe delivery group are logged off, during peak time.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LimitSecondsToForceLogOffUserDuringOffPeak": { "title": "Int32", "type": "integer", "description": "represents the number of seconds that must elapsed before\nthe active sessions on the draining machines belonging\nto the delivery group are logged off, during off-peak.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LogOffWarningMessage": { "title": "String", "type": "string", "description": "The warning message to display to users in active sessions prior to logging off users,\nwhether in peak time or off-peak.", "nullable": true }, "LogOffWarningTitle": { "title": "String", "type": "string", "description": "The title of the warning message dialog.", "nullable": true }, "LoadBalanceType": { "description": "Boolean value Indicates whether to use vertical scaling when\nfinding an RDS machine in the desktop group for a session launch.\nVertical scaling would saturate machines in the current pool\nrather than send sessions to the least loaded machines.\n \nThis would be a trade in performance vs. cost, where vertical scaling would\nbe less costly.\n \nWith the value None, the site-wide value will be inherited.\nA value of Horizontal indicates that horizontal scaling should be used.\nA value of Vertical indicates that vertical scaling should be used.", "nullable": true, "$ref": "#/components/schemas/LoadBalanceType" }, "RestrictAutoscaleMinIdleUntaggedPercentDuringPeak": { "title": "Int32", "type": "integer", "description": "The percentage that the number of untagged single-session machines\nin an idle state, or for multi-session machines, the untagged available\nload capacity must fall below before Autoscale powers on and manages 'tagged'\nmachines, as per policy, in peak time. If the number of untagged machines in\nan idle state, or the untagged available load capacity goes above this threshold value,\nAutoscale will attempt to shut down 'tagged' machines.", "format": "int32", "default": -1, "maximum": 100.0, "minimum": -1.0, "nullable": true }, "RestrictAutoscaleMinIdleUntaggedPercentDuringOffPeak": { "title": "Int32", "type": "integer", "description": "The percentage that the number of untagged single-session machines in an idle state,\nor for multi-session machines, the untagged available load capacity must fall below\nbefore Autoscale powers on and manages 'tagged' machines, as per policy, in off-peak.\nIf the number of untagged machines in an idle state, or the untagged available load capacity\ngoes above this threshold value, Autoscale will attempt to shut down 'tagged' machines.", "format": "int32", "default": -1, "maximum": 100.0, "minimum": -1.0, "nullable": true }, "AutoscaleLogOffReminderEnabled": { "title": "Boolean", "type": "boolean", "description": "Boolean value indicating whether the warning messages should be\nsent on an interval to nudge a logoff\nshould be sent on an interval when autoscale is enabled.", "default": false, "nullable": true }, "AutoscaleLogOffReminderIntervalSecondsOffPeak": { "title": "Int32", "type": "integer", "description": "Represents the time interval at which messages are sent to the user during off peak time\nwhen autoscale is enabled.\nThis message will nudge users to log off instead of forcibly logging them off.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "AutoscaleLogOffReminderIntervalSecondsPeak": { "title": "Int32", "type": "integer", "description": "Represents the time interval at which messages are sent to the user during peak time\nwhen autoscale is enabled.\nThis message will nudge users to log off instead of forcibly logging them off.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "PeakAutoscaleAssignedPowerOnIdleTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action is performed on an assigned machine previously\nstarted by autoscale that subsequently remains unused.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "PeakAutoscaleAssignedPowerOnIdleAction": { "description": "The action to be performed on an assigned machine started by Autoscale\nif that machine then remains unused for a defined period of time.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "AutoscaleLogOffReminderMessage": { "title": "String", "type": "string", "description": "Notification message to display to users in active sessions\nbelonging to machines needed by Autoscale for shutdown.", "nullable": true }, "AutoscaleLogOffReminderTitle": { "title": "String", "type": "string", "description": "Notification message dialog title displayed\nwhen Autoscale issues a logoff reminder request.", "nullable": true }, "PeakBufferSizePercent": { "title": "Int32", "type": "integer", "description": "The percentage of machines in the delivery group that should be kept\navailable in an idle state in peak hours.", "format": "int32", "default": 0, "maximum": 100.0, "minimum": 0.0, "nullable": true }, "PeakDisconnectAction": { "description": "The action to be performed after a configurable period of a user\nsession disconnecting in peak hours.", "default": "Nothing", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session disconnects in peak hours.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "PeakExtendedDisconnectAction": { "description": "The action to be performed after a second configurable period of a\nuser session disconnecting in peak hours.", "default": "Nothing", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakExtendedDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the second configured action should be\nperformed after a user session disconnects in peak hours.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "PeakLogOffAction": { "description": "The action to be performed after a configurable period of a user\nsession ending in peak hours.", "default": "Nothing", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakLogOffTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session ends in peak hours.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "DisconnectPeakIdleSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which an idle session\nbelonging to the delivery group is disconnected during peak time.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "DisconnectOffPeakIdleSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which an idle session\nbelonging to the delivery group is disconnected during off-peak time.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LogoffPeakDisconnectedSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which a disconnected session\nbelonging to the delivery group is terminated during peak time.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LogoffOffPeakDisconnectedSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which a disconnected session\nbelonging to the delivery group is terminated during off-peak time.", "format": "int32", "default": 0, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "AutoscaleScaleDownActionDuringPeak": { "description": "Specifies the action to be used for Autoscale to scale down the number of machines in this desktop group during peak.\nPossible values are: Shutdown and Suspend. The default is Shutdown.", "default": "Shutdown", "nullable": true, "$ref": "#/components/schemas/AutoscaleScaleDownAction" }, "AutoscaleScaleDownActionDuringOffPeak": { "description": "Specifies the action to be used for Autoscale to scale down the number of machines in this desktop group during off-peak.\nPossible values are: Shutdown and Suspend. The default is Shutdown.", "default": "Shutdown", "nullable": true, "$ref": "#/components/schemas/AutoscaleScaleDownAction" }, "PrelaunchSettings": { "description": "Prelaunch settings for users with resources published from\nthe delivery group.", "nullable": true, "$ref": "#/components/schemas/FastApplicationSettingsRequestModel" }, "PowerTimeSchemes": { "title": "PowerTimeSchemeRequestModel[]", "type": "array", "description": "Power management time schemes. No two schemes for the same delivery\ngroup may cover the same day of the week.", "nullable": true, "items": { "$ref": "#/components/schemas/PowerTimeSchemeRequestModel" } }, "PowerOffDelayMinutes": { "title": "Int32", "type": "integer", "description": "Delay before machines are powered off, when scaling down. Specified\nin minutes. Applies only to multi-session machines.", "format": "int32", "default": 30, "maximum": 60.0, "minimum": 0.0, "nullable": true }, "MachineCost": { "title": "Double", "type": "number", "description": "Indicates the estimated per-hour cost for machines in the delivery\ngroup, as set by the administrator.", "format": "double", "minimum": 0.0, "nullable": true }, "MachineLogOnType": { "description": "The login type for machines in this desktop group.", "nullable": true, "$ref": "#/components/schemas/MachineLogOnType" }, "ProductCode": { "title": "String", "type": "string", "description": "The product code of the delivery group.", "nullable": true }, "ReuseMachinesWithoutShutdownInOutage": { "title": "Boolean", "type": "boolean", "description": "Whether machines will be reused without a shutdown in case of an outage.", "nullable": true }, "LicenseModel": { "description": "The license model of the delivery group.", "nullable": true, "$ref": "#/components/schemas/LicenseModel" }, "ProtocolPriority": { "title": "ProtocolType[]", "type": "array", "description": "A list of protocols in the order in which they should be\nattempted for use during connection.", "nullable": true, "items": { "$ref": "#/components/schemas/ProtocolType" } }, "RebootSchedules": { "title": "RebootScheduleRequestModel[]", "type": "array", "description": "Reboot schedules. No two schedules for the same delivery group may\ncover the same day of the week.", "nullable": true, "items": { "$ref": "#/components/schemas/RebootScheduleRequestModel" } }, "SecureIcaRequired": { "title": "Boolean", "type": "boolean", "description": "Whether HDX connections to machines in the delivery group\nrequire the use of the SecureICA protocol.", "nullable": true }, "SettlementPeriodBeforeAutoShutdownSeconds": { "title": "Int32", "type": "integer", "description": "Time after a session ends during which automatic shutdown\nrequests (for example, shutdown after use, idle pool\nmanagement) are deferred. Any outstanding shutdown request\ntakes effect after the settlement period expires. This is\ntypically used to configure time to allow logoff scripts\nto complete.", "format": "int32", "default": 0, "nullable": true }, "SettlementPeriodBeforeUseSeconds": { "title": "Int32", "type": "integer", "description": "Idle period before a machine can be selected to host a new\nsession after registration or the end of a previous\nsession. This is typically used to allow a machine to\nbecome idle following processing associated with start-up\nor logoff actions. A machine may still be selected during\nthe idle period if no other machine is available for\nimmediate use.", "format": "int32", "default": 0, "nullable": true }, "ShutdownDesktopsAfterUse": { "title": "Boolean", "type": "boolean", "description": "Whether machines in this delivery group should be\nautomatically shut down when each user session completes.", "default": false, "nullable": true }, "SimpleAccessPolicy": { "description": "Simplified access policy for connections to the delivery group.", "nullable": true, "$ref": "#/components/schemas/SimplifiedAccessPolicyRequestModel" }, "StoreFrontServersForHostedReceiver": { "title": "StoreFrontServerRequestModel[]", "type": "array", "description": "List of StoreFront server addresses to configure within hosted\nreceivers that are delivered from the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/StoreFrontServerRequestModel" } }, "TimeZone": { "title": "String", "type": "string", "description": "The time zone in which this delivery group's machines reside.", "nullable": true, "example": "For example, America/New_York" }, "TurnOnAddedMachines": { "title": "Boolean", "type": "boolean", "description": "Whether to attempt to power on machines when they are added to the\ndelivery group.", "nullable": true }, "ZonePreferences": { "title": "ZonePreference[]", "type": "array", "description": "Ordered list of zone preferences to be applied when launching\nresources from this delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/ZonePreference" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the new delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "PolicySetGuid": { "title": "Guid", "type": "string", "description": "The GUID of the policy set assigned to this desktop group.", "format": "guid" }, "RequiredSleepCapability": { "description": "The sleep capability of this desktop group.", "nullable": true, "$ref": "#/components/schemas/RequiredSleepCapability" } } }, "CreateHolidayAutoscaleGroupPluginRequestModel": { "title": "CreateHolidayAutoscaleGroupPluginRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateAutoscaleGroupPluginRequestModel" }, { "type": "object", "description": "Create a new Holiday autoscale group plugin.", "additionalProperties": false, "required": [ "Dates" ], "properties": { "Dates": { "title": "String[]", "type": "array", "description": "Date range for the autoscale holiday plugin (yyyy-MM-dd format). Required.", "items": { "title": "String", "type": "string" } }, "OverrideTimeSchemeUid": { "title": "Int32", "type": "integer", "description": "A power time scheme UID to use for holiday days. Optional.", "format": "int32", "nullable": true } } } ] }, "CreateHypervisorRequestModel": { "title": "CreateHypervisorRequestModel", "type": "object", "description": "Create hypervisor request model. Note that in previous versions of the\nAPI, a \"hypervisor\" was known as a \"connection\".", "additionalProperties": false, "required": [ "ConnectionDetails" ], "properties": { "ConnectionDetails": { "description": "Connection details. Required.", "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, "PoolDetails": { "description": "Resource pool to create. Optional.", "nullable": true, "$ref": "#/components/schemas/CreateHypervisorResourcePoolRequestModel" } } }, "CreateHypervisorResourcePoolAWCRequestModel": { "title": "CreateHypervisorResourcePoolAWCRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateHypervisorResourcePoolRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "VirtualPrivateCloud", "AvailabilityZone", "Networks" ], "properties": { "VirtualPrivateCloud": { "title": "String", "type": "string", "description": "Amazon WorkSpaces Core Virtual Private Cloud (VPC) resource which the resource pool is\nconnected to. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "AvailabilityZone": { "title": "String", "type": "string", "description": "Path to the availability zone resource to use for provisioning\noperations in this resource pool. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "Networks": { "title": "String[]", "type": "array", "description": "Path to the network resource(s) that are available for provisioning\noperations in this resource pool. At least one is required.", "items": { "title": "String", "type": "string" } } } } ] }, "CreateHypervisorResourcePoolAWSRequestModel": { "title": "CreateHypervisorResourcePoolAWSRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateHypervisorResourcePoolRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "VirtualPrivateCloud", "AvailabilityZone", "Networks" ], "properties": { "VirtualPrivateCloud": { "title": "String", "type": "string", "description": "AWS Virtual Private Cloud (VPC) resource which the resource pool is\nconnected to. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "AvailabilityZone": { "title": "String", "type": "string", "description": "Path to the availability zone resource to use for provisioning\noperations in this resource pool. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "Networks": { "title": "String[]", "type": "array", "description": "Path to the network resource(s) that are available for provisioning\noperations in this resource pool. At least one is required.", "items": { "title": "String", "type": "string" } } } } ] }, "CreateHypervisorResourcePoolAzureRequestModel": { "title": "CreateHypervisorResourcePoolAzureRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateHypervisorResourcePoolRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "Region", "VirtualNetwork", "Subnets" ], "properties": { "Region": { "title": "String", "type": "string", "description": "Azure region which the resource pool is connected to. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "VirtualNetwork": { "title": "String", "type": "string", "description": "Azure virtual network which the resource pool is connected to.\nRequired.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "Subnets": { "title": "String[]", "type": "array", "description": "Path to the subnet(s) that are available for provisioning operations\nin this resource pool. At least one is required.", "items": { "title": "String", "type": "string" } } } } ] }, "CreateHypervisorResourcePoolGcpRequestModel": { "title": "CreateHypervisorResourcePoolGcpRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateHypervisorResourcePoolRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "Region", "VirtualPrivateCloud", "Networks" ], "properties": { "Region": { "title": "String", "type": "string", "description": "Google Cloud Platform region which the resource pool is connected to. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "VirtualPrivateCloud": { "title": "String", "type": "string", "description": "Google Cloud Platform virtual network which the resource pool is connected to.\nRequired.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "Networks": { "title": "String[]", "type": "array", "description": "Path to the subnet(s) that are available for provisioning operations\nin this resource pool. At least one is required.", "items": { "title": "String", "type": "string" } } } } ] }, "CreateHypervisorResourcePoolNutanixPCRequestModel": { "title": "CreateHypervisorResourcePoolNutanixPCRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateHypervisorResourcePoolRequestModel" }, { "type": "object", "additionalProperties": false } ] }, "CreateHypervisorResourcePoolRequestModel": { "title": "CreateHypervisorResourcePoolRequestModel", "type": "object", "description": "Create a hypervisor resource pool. Note that in previous versions of\nthe API, a \"resource pool\" was known as a \"hosting unit\".", "additionalProperties": false, "required": [ "Name", "ConnectionType" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the resource pool to create. Required.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*", "example": "Name of the resource pool" }, "VmTagging": { "title": "Boolean", "type": "boolean", "description": "Indicates whether VMs created by Virtual Apps & Desktops\nprovisioning operations should be tagged. Tagged VMs are filtered\nout of queries by default.\nOptional. Default is `true`.", "default": true, "nullable": true }, "GpuTypes": { "title": "String[]", "type": "array", "description": "Path to the GPU type resource(s) that are available for provisioning\noperations in this resource pool. Optional. Not supported by all\nhypervisor types.", "nullable": true, "example": [ "Name of a GPU type" ], "items": { "title": "String", "type": "string" } }, "ConnectionType": { "description": "Type of hypervisor. Required, and must match the type of hypervisor\nspecified for the hypervisor connection that the resource pool is\nattached to.", "$ref": "#/components/schemas/HypervisorConnectionType" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata of the resource pool. Optional.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "VirtualPrivateCloud": { "title": "String", "type": "string", "description": "AWS Virtual Private Cloud (VPC) resource which the resource pool is\nconnected to. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "AvailabilityZone": { "title": "String", "type": "string", "description": "Path to the availability zone resource to use for provisioning\noperations in this resource pool. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "Networks": { "title": "String[]", "type": "array", "description": "Path to the network resource(s) that are available for provisioning\noperations in this resource pool. At least one is required.", "items": { "title": "String", "type": "string" } }, "Region": { "title": "String", "type": "string", "description": "Azure region which the resource pool is connected to. Required.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "VirtualNetwork": { "title": "String", "type": "string", "description": "Azure virtual network which the resource pool is connected to.\nRequired.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*" }, "Subnets": { "title": "String[]", "type": "array", "description": "Path to the subnet(s) that are available for provisioning operations\nin this resource pool. At least one is required.", "items": { "title": "String", "type": "string" } }, "RootPath": { "title": "String", "type": "string", "description": "Root path of the resources on the hypervisor which should be\nincluded in the resource pool. Required.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true }, "UseLocalStorageCaching": { "title": "Boolean", "type": "boolean", "description": "Indicates whether local storage on the hypervisor will be used for\ncaching purposes. Not all hypervisor types support this. Defaults\nto `false`.", "default": false, "nullable": true }, "Storage": { "title": "String[]", "type": "array", "description": "Path to the storage resource(s) that are available for provisioning\noperations in this resource pool. Required for some hypervisor\ntypes.", "nullable": true, "items": { "title": "String", "type": "string" } }, "PersonalvDiskStorage": { "title": "String[]", "type": "array", "description": "Path to the storage resource(s) that are available for provisioning\noperations in this resource pool. Required for some hypervisor\ntypes.", "nullable": true, "items": { "title": "String", "type": "string" } }, "TemporaryStorage": { "title": "String[]", "type": "array", "description": "Path to the storage resource(s) that are used for temporary\noperations in this resource pool. Required for some hypervisor\ntypes.", "nullable": true, "items": { "title": "String", "type": "string" } }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true }, "StorageBalanceType": { "description": "Storage Balance Type. Only used for hypervisors of type\nXenServer.\nSCVMM.\nVCenter.", "nullable": true, "$ref": "#/components/schemas/StorageBalanceType" } } }, "CreateHypervisorResourcePoolTraditionalRequestModel": { "title": "CreateHypervisorResourcePoolTraditionalRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateHypervisorResourcePoolRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "Networks" ], "properties": { "RootPath": { "title": "String", "type": "string", "description": "Root path of the resources on the hypervisor which should be\nincluded in the resource pool. Required.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true }, "Networks": { "title": "String[]", "type": "array", "description": "Path to the network resource(s) that are available for provisioning\noperations in this resource pool. At least one is required.", "items": { "title": "String", "type": "string" } }, "UseLocalStorageCaching": { "title": "Boolean", "type": "boolean", "description": "Indicates whether local storage on the hypervisor will be used for\ncaching purposes. Not all hypervisor types support this. Defaults\nto `false`.", "default": false, "nullable": true }, "Storage": { "title": "String[]", "type": "array", "description": "Path to the storage resource(s) that are available for provisioning\noperations in this resource pool. Required for some hypervisor\ntypes.", "nullable": true, "items": { "title": "String", "type": "string" } }, "PersonalvDiskStorage": { "title": "String[]", "type": "array", "description": "Path to the storage resource(s) that are available for provisioning\noperations in this resource pool. Required for some hypervisor\ntypes.", "nullable": true, "items": { "title": "String", "type": "string" } }, "TemporaryStorage": { "title": "String[]", "type": "array", "description": "Path to the storage resource(s) that are used for temporary\noperations in this resource pool. Required for some hypervisor\ntypes.", "nullable": true, "items": { "title": "String", "type": "string" } }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true }, "StorageBalanceType": { "description": "Storage Balance Type. Only used for hypervisors of type\nXenServer.\nSCVMM.\nVCenter.", "nullable": true, "$ref": "#/components/schemas/StorageBalanceType" } } } ] }, "CreateImageDefinitionRequestModel": { "title": "CreateImageDefinitionRequestModel", "type": "object", "description": "Request object for creation of image definitions.", "additionalProperties": false, "required": [ "Name", "OsType", "VDASessionSupport" ], "properties": { "Name": { "title": "String", "type": "string", "description": "The name associated with the image definition.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "Description": { "title": "String", "type": "string", "description": "The description associated with the image definition.", "maxLength": 512, "pattern": "(.*)*", "nullable": true }, "OsType": { "description": "Specifies the OS Type of images in the image definition.", "$ref": "#/components/schemas/OsType" }, "VDASessionSupport": { "description": "Specifies the session support of images in the image definition.", "$ref": "#/components/schemas/SessionSupport" }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the newly created image definition will\nbe a part of.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "AssignedHypervisorConnection": { "description": "Specifies the hypervisor connection assignment to image definition.", "nullable": true, "$ref": "#/components/schemas/AssignHypervisorConnectionToImageDefinitionRequestModel" } } }, "CreateImageSchemeRequestModel": { "title": "CreateImageSchemeRequestModel", "type": "object", "description": "Request object for creation of image scheme.", "additionalProperties": false, "properties": { "ServiceOfferingPath": { "title": "String", "type": "string", "description": "The hypervisor resource path of the Cloud service offering to use when creating machines.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, serviceOffering.folder/{{offering name}}.serviceOffering" }, "MachineProfile": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine template that will be used.\nThis identifies the VM template to be used and the default values for the tags,\nvirtual machine size, boot diagnostics, host cache property of OS disk,\naccelerated networking and availability zone.\nThis must be a path to a Virtual machine or Template item in the\nresource pool to which the Image Version Specification is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, XDHyp:\\path\\to\\VirtualMachine" }, "CpuCount": { "title": "Int32", "type": "integer", "description": "The number of processors that virtual machines created from the\nimage preparing should use.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "The maximum amount of memory that virtual machines created from the\nimage preparing should use.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "NetworkMapping": { "title": "NetworkMapRequestModel[]", "type": "array", "description": "Specifies how the attached NICs are mapped to networks. If this parameter is\nomitted, provisioned VMs are created with a single NIC, which is mapped to the\ndefault network in the hypervisor resource pool. If this parameter is supplied,\nmachines are created with the number of NICs specified in the map, and each NIC\nis attached to the specified network.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapRequestModel" } }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the image version specification that are specific to the\ntarget hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "CreateImageVersionRequestModel": { "title": "CreateImageVersionRequestModel", "type": "object", "description": "Request object for creation of image versions.", "additionalProperties": false, "required": [ "ImageScheme", "MasterImagePath", "ResourcePool" ], "properties": { "Description": { "title": "String", "type": "string", "description": "The description associated with the image version.", "maxLength": 512, "pattern": "(.*)*", "nullable": true }, "ImageScheme": { "description": "Defines the image scheme for the image version specification.", "$ref": "#/components/schemas/CreateImageSchemeRequestModel" }, "MasterImagePath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine snapshot\nor VM template that will be used. This identifies the hard disk\nto be used and the default values for the memory and processors.\nThis must be a path to a Snapshot or Template item in the\nresource pool to which the Image Version Specification is associated.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "example": "For example, XDHyp:\\path\\to\\MasterImage" }, "ResourcePool": { "title": "String", "type": "string", "description": "Hypervisor resource pool Id or name in which image version specification locates", "minLength": 1 } } }, "CreateInstalledAppRequestModel": { "title": "CreateInstalledAppRequestModel", "type": "object", "description": "Request object for installed application properties.", "additionalProperties": false, "required": [ "CommandLineExecutable" ], "properties": { "CommandLineArguments": { "title": "String", "type": "string", "description": "Specifies the command-line arguments to use when launching the\nexecutable. Environment variables can be used.", "maxLength": 8191, "nullable": true, "example": "For example, --debug" }, "CommandLineExecutable": { "title": "String", "type": "string", "description": "Specifies the name of the executable file to launch. The full\npath need not be provided if it's already in the path.\nEnvironment variables can also be used.", "maxLength": 8191, "minLength": 1, "example": "For example, C:\\test\\test.exe" }, "WorkingDirectory": { "title": "String", "type": "string", "description": "Specifies which working directory the executable is launched\nfrom. Environment variables can be used. ", "nullable": true, "example": "For example, C:\\test" } } }, "CreateIntelligentAutoscaleGroupPluginRequestModel": { "title": "CreateIntelligentAutoscaleGroupPluginRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateAutoscaleGroupPluginRequestModel" }, { "type": "object", "description": "Create a new Intelligent autoscale group plugin.", "additionalProperties": false, "required": [ "PerformanceTarget" ], "properties": { "PerformanceTarget": { "title": "Int32", "type": "integer", "description": "The performance target percentage for the Intelligent plugin. Required.\nValid range: 1-100.", "format": "int32", "maximum": 100.0, "minimum": 1.0 } } } ] }, "CreateLicensingAdminRequestModel": { "title": "CreateLicensingAdminRequestModel", "type": "object", "description": "Request object for creation of licensing admin.", "additionalProperties": false, "required": [ "AccountSamName" ], "properties": { "AccountSamName": { "title": "String", "type": "string", "description": "The same name of the account", "minLength": 1 }, "AccountSid": { "title": "String", "type": "string", "description": "The sid of the account", "nullable": true }, "Permissions": { "description": "The permission of the account", "$ref": "#/components/schemas/LicensingPermissionLevel" }, "IsGroup": { "title": "Boolean", "type": "boolean", "description": "Whether this account is a group account" } } }, "CreateMachineCatalogProvisioningSchemeRequestModel": { "title": "CreateMachineCatalogProvisioningSchemeRequestModel", "type": "object", "description": "Request object for the scheme used for provisioned\nmachines in a machine catalog.", "additionalProperties": false, "properties": { "ResourcePool": { "title": "String", "type": "string", "description": "The HostingUnit name or Id in which machine catalog locates", "nullable": true }, "MasterImagePath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine snapshot\nor VM template that will be used. This identifies the hard disk\nto be used and the default values for the memory and processors.\nThis must be a path to a Snapshot or Template item in the\nresource pool to which the Machine Catalog is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, XDHyp:\\path\\to\\MasterImage" }, "AssignImageVersionToProvisioningScheme": { "description": "Image version assignment to this provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/AssignImageVersionToProvisioningSchemeRequestModel" }, "MachineProfilePath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine template that will be used.\nThis identifies the VM template to be used and the default values for the tags,\nvirtual machine size, boot diagnostics, host cache property of OS disk,\naccelerated networking and availability zone.\nThis must be a path to a Virtual machine or Template item in the\nresource pool to which the Machine Catalog is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, XDHyp:\\path\\to\\VirtualMachine" }, "MasterImageNote": { "title": "String", "type": "string", "description": "The note for the master image.", "nullable": true }, "CpuCount": { "title": "Int32", "type": "integer", "description": "The number of processors that virtual machines created from the\nprovisioning scheme should use.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "CoresPerCpuCount": { "title": "Int32", "type": "integer", "description": "The number of cores per processor that virtual machines created from the\nprovisioning scheme should use.", "format": "int32", "maximum": 99.0, "minimum": 0.0, "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "The maximum amount of memory that virtual machines created from the\nprovisioning scheme should use.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "UseWriteBackCache": { "title": "Boolean", "type": "boolean", "description": "Indicates whether or not write back cache is enabled for the VMs created from this provisioning scheme.\nOptional; default is `false`.", "default": false, "nullable": true }, "WriteBackCacheDiskSizeGB": { "title": "Int32", "type": "integer", "description": "The size in GB of any temporary storage disk used by the write back cache.\nShould be used in conjunction with WriteBackCacheMemorySizeMB.", "format": "int32", "nullable": true }, "WriteBackCacheMemorySizeMB": { "title": "Int32", "type": "integer", "description": "The size in MB of any write back cache if required.\nShould be used in conjunction with WriteBackCacheDiskSizeGB.", "format": "int32", "nullable": true }, "WriteBackCacheDriveLetter": { "title": "Char", "type": "string", "description": "The drive letter assigned for write back cache disk when UseWriteBackCache is `true`." }, "PrepareImage": { "title": "Boolean", "type": "boolean", "description": "Indicates whether image preparation should be performed on this provisioning scheme.\nOptional; default is `true`.", "default": true, "nullable": true }, "NetworkMapping": { "title": "NetworkMapRequestModel[]", "type": "array", "description": "Specifies how the attached NICs are mapped to networks. If this parameter is\nomitted, provisioned VMs are created with a single NIC, which is mapped to the\ndefault network in the hypervisor resource pool. If this parameter is supplied,\nmachines are created with the number of NICs specified in the map, and each NIC\nis attached to the specified network.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapRequestModel" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata for provisioning scheme", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ServiceOfferingPath": { "title": "String", "type": "string", "description": "The hypervisor resource path of the Cloud service offering to use when creating machines.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, serviceOffering.folder/{{offering name}}.serviceOffering" }, "SecurityGroups": { "title": "String[]", "type": "array", "description": "The hypervisor resource path(s) of the Cloud security group(s) to use when creating machines.", "nullable": true, "example": [ "For example", " securityGroup.folder/{{security group name}}.securityGroup" ], "items": { "title": "String", "type": "string" } }, "DedicatedTenancy": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to use dedicated tenancy when creating machines in Cloud Hypervisors.\nOptional; default is `false`.", "default": false, "nullable": true }, "TenancyType": { "description": "Indicates whether to use tenancy type Shared, Instance or Host when creating machines in Cloud Hypervisors.\nOptional; default is `Shared`.", "default": "Shared", "nullable": true, "$ref": "#/components/schemas/TenancyType" }, "AzureAdJoinType": { "description": "Indicates whether to use Microsoft Entra join type.\nOptional; default is `None`.", "default": "None", "nullable": true, "$ref": "#/components/schemas/AzureAdJoinType" }, "IdentityType": { "description": "Indicates whether to use identity type.\nOptional; default is `ActiveDirectory`.", "default": "ActiveDirectory", "nullable": true, "$ref": "#/components/schemas/IdentityType" }, "DeviceManagementType": { "description": "Indicates whether to use device management type.\nOptional; default is `None`.", "default": "None", "nullable": true, "$ref": "#/components/schemas/DeviceManagementType" }, "AzureADSecurityGroupName": { "title": "String", "type": "string", "description": "Name of Microsoft Entra ID security group to be created.", "nullable": true }, "AzureADSecurityGroupNestId": { "title": "String", "type": "string", "description": "The object id of the Microsoft Entra ID security group to nest.\n\nOnly valid for Azure. Mandatory when to nest created security group.", "nullable": true }, "AzureADSecurityGroupNestName": { "title": "String", "type": "string", "description": "The object name of the Microsoft Entra ID security group to nest.\nOnly valid for Azure. If specified, AzureADSecurityGroupNestId is required.", "nullable": true }, "AzureADTenantId": { "title": "Guid", "type": "string", "description": "TenantId of Azure Directory.", "format": "guid", "nullable": true }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the provisioning scheme that are specific to the\ntarget hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "CustomPropertiesInString": { "title": "String", "type": "string", "description": "The properties of the provisioning scheme in a single string, that are\nspecific to the target hosting infrastructure. This is an optional method\nto set the custom properties which are not in the form of an array.", "nullable": true }, "ResetAdministratorPasswords": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to reset the password for the administrator accounts on provisioned machines.\nOptional; default is `false`.", "default": false, "nullable": true }, "UseFullDiskCloneProvisioning": { "title": "Boolean", "type": "boolean", "description": "Indicates that the virtual machines created from the provisioning scheme should be created using the dedicated full disk clone feature.\nOptional; default is `false`.", "default": false, "nullable": true }, "WorkGroupMachines": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to provision workgroup virtual machines e.g. non-domain joined.\nOptional; default is `false`.", "default": false, "nullable": true }, "NumTotalMachines": { "title": "Int32", "type": "integer", "description": "Number of machines to provision initially. Optional; default is 1. It is valid\nto request 0 machines initially.", "format": "int32", "default": 1, "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "MachineAccountCreationRules": { "description": "Rules specifying how Active Directory machine accounts should be created when machines are provisioned.", "nullable": true, "$ref": "#/components/schemas/MachineAccountCreationRulesRequestModel" }, "AvailableMachineAccounts": { "title": "MachineAccountRequestModel[]", "type": "array", "description": "List of Active Directory machine accounts that are to be used when machines are provisioned.", "nullable": true, "items": { "$ref": "#/components/schemas/MachineAccountRequestModel" } }, "PVSSite": { "title": "String", "type": "string", "description": "PVS site id.", "nullable": true }, "PVSVDisk": { "title": "String", "type": "string", "description": "PVS vDisk id.", "nullable": true }, "ServiceAccountUid": { "title": "String[]", "type": "array", "description": "Indicates whether to associate service accounts to the IdentityPool.", "nullable": true, "items": { "title": "String", "type": "string" } }, "DataDisk": { "title": "String", "type": "string", "description": "The hypervisor resource path of the data disk to be used for the machines created from this provisioning scheme.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true }, "DataDiskPersistence": { "description": "Indicates the persistence of the data disk for machines created from this provisioning scheme.", "default": "Unknown", "nullable": true, "$ref": "#/components/schemas/DataDiskPersistence" }, "EntraIDExtensionAttributes": { "title": "Dictionary`2", "type": "object", "description": "The value to set extension attributes of Microsoft Entra ID device of Microsoft Entra joined machines.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "VtpmProvisionPolicy": { "description": "The vTPM provisioning policy of the provisioning scheme.", "default": "None", "nullable": true, "$ref": "#/components/schemas/VtpmProvisionPolicy" }, "ProvisioningSchemeType": { "title": "String", "type": "string", "nullable": true } } }, "CreateMachineCatalogRequestModel": { "title": "CreateMachineCatalogRequestModel", "type": "object", "description": "Request object for creation of machine catalogs.", "additionalProperties": false, "required": [ "Name", "ProvisioningType", "SessionSupport" ], "properties": { "AdminFolder": { "title": "String", "type": "string", "description": "The admin folder in which the machine catalog\nshould be created.", "nullable": true, "example": "Path or Id of the admin folder" }, "Name": { "title": "String", "type": "string", "description": "Name of the machine catalog. Each machine catalog within a site\nmust have a unique name. Required.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*", "example": "Name of the machine catalog" }, "AllocationType": { "description": "Denotes how the machines in the catalog are allocated to a user.", "nullable": true, "$ref": "#/components/schemas/AllocationType" }, "Description": { "title": "String", "type": "string", "description": "Description of the machine catalog. Optional. Default is no\ndescription.", "maxLength": 512, "pattern": "(.*)*", "nullable": true, "example": "Description of the machine catalog" }, "HypervisorConnection": { "title": "String", "type": "string", "description": "Specifies the hypervisor connection to use for power management of\nmachines in this machine catalog.", "nullable": true, "example": "Name of the hypervisor connection" }, "IsRemotePC": { "title": "Boolean", "type": "boolean", "description": "Indicates whether or not the catalog is a RemotePC catalog. Default\nis `false`.", "default": false, "nullable": true }, "RemotePCEnrollmentScopes": { "title": "RemotePCEnrollmentScopeRequestModel[]", "type": "array", "description": "List of one or more remote PC enrollment scopes.", "nullable": true, "items": { "$ref": "#/components/schemas/RemotePCEnrollmentScopeRequestModel" } }, "MachineType": { "description": "Type of the machines in the machine catalog. Optional.", "nullable": true, "$ref": "#/components/schemas/MachineType" }, "MinimumFunctionalLevel": { "description": "The minimum functional level of machines in the machine catalog.\nOptional. Default is based on a site setting; see\nDefaultMinimumFunctionalLevel.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "PersistUserChanges": { "description": "Specifies how user changes are persisted on machines in the machine\ncatalog. Required if SessionSupport is\nSingleSession and\nAllocationType is Static.\nCannot be specified otherwise.", "nullable": true, "$ref": "#/components/schemas/PersistChanges" }, "ProvisioningType": { "description": "Specifies how the machines are provisioned in the catalog.\nRequired.", "$ref": "#/components/schemas/ProvisioningType" }, "ProvisioningScheme": { "description": "Defines the provisioning scheme for the catalog. Required if\nProvisioningType equals\nMCS. Must not be specified\notherwise.", "nullable": true, "$ref": "#/components/schemas/CreateMachineCatalogProvisioningSchemeRequestModel" }, "ProvisioningSchemeImportData": { "description": "Special case, the MCS catalog has been exported from another site.", "nullable": true, "$ref": "#/components/schemas/MCSImportData" }, "Machines": { "title": "AddMachineToMachineCatalogRequestModel[]", "type": "array", "description": "List of machines to add to the catalog.\n\nMust not be specified if equals\n or\n. Optional otherwise. Default is\nnot to add any machines.", "nullable": true, "items": { "$ref": "#/components/schemas/AddMachineToMachineCatalogRequestModel" } }, "PvsAddress": { "title": "String", "type": "string", "description": "IP address of the PVS server to be used. This only applies if the\nProvisioningType is PVS.", "maxLength": 255, "pattern": "UNKNOWN", "nullable": true, "example": "For example, 1.1.1.1" }, "PvsDomain": { "title": "String", "type": "string", "description": "The domain of the PVS server to be used.\nThis only applies if the ProvisioningType is\nPVS.", "maxLength": 255, "pattern": "UNKNOWN", "nullable": true, "example": "For example, PVS.local" }, "PvsCollectionIds": { "title": "String[]", "type": "array", "description": "Collection IDs of PVS collections containing machines that should be\nadded to the catalog. This only applies if the\nProvisioningType is\nPVS, and is required in that case.\n\nEach item must be a valid PVS collection ID residing on the PVS\nserver located at the specified .", "nullable": true, "example": [ "Id of a PVS collection" ], "items": { "title": "String", "type": "string" } }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the newly created machine catalog will\nbe a part of.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenant(s) to associate the machine catalog with.", "nullable": true, "example": [ "Name of a tenant" ], "items": { "title": "String", "type": "string" } }, "SessionSupport": { "description": "Specifies the session support of the machines in the machine\ncatalog. Required.", "$ref": "#/components/schemas/SessionSupport" }, "VdaUpgradeType": { "description": "VDA upgrade type of this machine catalog. Optional.\nIf not set, the upgrade type defaults to None\nand VDA machines in this catalog will not be upgraded automatically.", "nullable": true, "$ref": "#/components/schemas/VdaUpgradeType" }, "Zone": { "title": "String", "type": "string", "description": "Zone the machine catalog is associated with. Optional. If not\nspecified, the machine catalog is associated with the primary zone.\nSee PrimaryZone.", "nullable": true, "example": "Name or Id of a zone" }, "HypervisorVMTagging": { "title": "Boolean", "type": "boolean", "description": "Indicates that assigned VMs from this catalog will carry a hypervisor-level tag.", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of machine catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "CreateMachineConfigurationRequestModel": { "title": "CreateMachineConfigurationRequestModel", "type": "object", "description": "Request object for creating a machine configuration.", "additionalProperties": false, "required": [ "ConfigurationSlotId", "LeafName", "Policy" ], "properties": { "ConfigurationSlotId": { "title": "Int32", "type": "integer", "description": "Id of the configuration slot to associate with this machine configuration.", "format": "int32" }, "LeafName": { "title": "String", "type": "string", "description": "Name of the new machine configuration.", "maxLength": 64, "minLength": 1, "example": "SecureBrowserGPO" }, "Policy": { "title": "String", "type": "string", "description": "Policy settings data created with the SDK snap-in that matches the SettingsGroup of the configuration slot.\nBase64 encrypted.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of the new machine configuration.", "maxLength": 512, "nullable": true } } }, "CreateProvisionedVirtualMachineConfigurationRequestModel": { "title": "CreateProvisionedVirtualMachineConfigurationRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateProvisioningConfigurationBaseRequestModel" }, { "type": "object", "description": "Request object for creation of Provisioned VM configuration version.", "additionalProperties": false, "properties": { "RemoveCustomizations": { "title": "Boolean", "type": "boolean", "description": "Indicates whether custom VM configuration will be cleared.\nOptional. Default is `false`.", "default": false } } } ] }, "CreateProvisionedVMConfigurationAndScheduleUpdateRequestModel": { "title": "CreateProvisionedVMConfigurationAndScheduleUpdateRequestModel", "type": "object", "description": "Request object for creation of Provisioned VM configuration and scheduling a VM hardware update.", "additionalProperties": false, "properties": { "CreateProvisionedVMConfiguration": { "description": "The model to create prov VM configuration.", "nullable": true, "$ref": "#/components/schemas/CreateProvisionedVirtualMachineConfigurationRequestModel" }, "ScheduleProvisionedVMHardwareUpdate": { "description": "The model to schedule a prov VM hardware update with the configuration created in CreateProvisionedVMConfiguration.", "nullable": true, "$ref": "#/components/schemas/ScheduleProvisionedVMTaskHardwareUpdateBaseRequestModel" } } }, "CreateProvisioningConfigurationBaseRequestModel": { "title": "CreateProvisioningConfigurationBaseRequestModel", "type": "object", "description": "Request object for creation of Provisioning configuration.", "additionalProperties": false, "properties": { "Description": { "title": "String", "type": "string", "description": "The description associated with the configuration version.", "maxLength": 512, "nullable": true }, "ServiceOfferingPath": { "title": "String", "type": "string", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true }, "MachineProfile": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine template that will be used.\nThis identifies the VM template to be used and the default values for the tags,\nvirtual machine size, boot diagnostics, host cache property of OS disk,\naccelerated networking and availability zone.\nThis must be a path to a Virtual machine or Template item in the\nresource pool to which the Image Version Specification is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, XDHyp:\\path\\to\\VirtualMachine" }, "CpuCount": { "title": "Int32", "type": "integer", "description": "The number of processors that virtual machines created from the\nimage preparing should use.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "The maximum amount of memory that virtual machines created from the\nimage preparing should use.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "NetworkMapping": { "title": "NetworkMapRequestModel[]", "type": "array", "description": "Specifies how the attached NICs are mapped to networks. If this parameter is\nomitted, provisioned VMs are created with a single NIC, which is mapped to the\ndefault network in the hypervisor resource pool. If this parameter is supplied,\nmachines are created with the number of NICs specified in the map, and each NIC\nis attached to the specified network.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapRequestModel" } }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the image version specification that are specific to the\ntarget hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "VtpmProvisionPolicy": { "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeVtpmPolicy" } } }, "CreateProvisioningSchemeConfigurationRequestModel": { "title": "CreateProvisioningSchemeConfigurationRequestModel", "allOf": [ { "$ref": "#/components/schemas/CreateProvisioningConfigurationBaseRequestModel" }, { "type": "object", "description": "Request object for creation of Provisioning Scheme configuration version.", "additionalProperties": false, "properties": { "WriteBackCacheDiskSizeGB": { "title": "Int32", "type": "integer", "description": "The size in GB of any temporary storage disk used by the write back cache.\nShould be used in conjunction with WriteBackCacheMemorySizeMB.", "format": "int32", "nullable": true }, "WriteBackCacheMemorySizeMB": { "title": "Int32", "type": "integer", "description": "The size in MB of any write back cache if required.\nShould be used in conjunction with WriteBackCacheDiskSizeGB.", "format": "int32", "nullable": true }, "SecurityGroups": { "title": "String[]", "type": "array", "description": "The hypervisor resource path(s) of the Cloud security group(s) to use when creating machines.", "nullable": true, "example": [ "For example, securityGroup.folder/{{security group name}}.securityGroup" ], "items": { "title": "String", "type": "string" } } } } ] }, "CreateServiceAccountRequestModel": { "title": "CreateServiceAccountRequestModel", "type": "object", "description": "Request model for creating a service account.", "additionalProperties": false, "required": [ "IdentityProviderType", "IdentityProviderIdentifier", "AccountId", "SecretExpiryTime", "AccountSecret" ], "properties": { "IdentityProviderType": { "title": "String", "type": "string", "description": "The identity provider type for the service account", "minLength": 1, "example": "Valid types: AzureAD, ActiveDirectory" }, "IdentityProviderIdentifier": { "title": "String", "type": "string", "description": "The identity provider id for the service account", "minLength": 1, "example": "Domain name if 'IdentityProviderType' is ActiveDirectory. Microsoft Entra tenant id if 'IdentityProviderType' is AzureAD" }, "AccountId": { "title": "String", "type": "string", "description": "The identifier for the service account", "minLength": 1, "example": "Domain user like \"cvad\\\\joe\" if 'IdentityProviderType' is ActiveDirectory\"" }, "SecretExpiryTime": { "title": "String", "type": "string", "description": "The secret expiration time for the service account", "minLength": 1 }, "AccountSecret": { "title": "String", "type": "string", "description": "The secret for the service account. E.g. Azure application (client) secret if 'IdentityProviderType' is AzureAD.", "minLength": 1 }, "AccountSecretFormat": { "description": "Format of the AccountSecret. Default is\nPlainText.", "default": "PlainText", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Capabilities": { "title": "String[]", "type": "array", "description": "The capabilities for the service account", "nullable": true, "items": { "title": "String", "type": "string" } }, "Scopes": { "title": "String[]", "type": "array", "description": "The scopes for this object", "nullable": true, "items": { "title": "String", "type": "string" } }, "TenantId": { "title": "Guid", "type": "string", "description": "The tenant id", "format": "guid", "nullable": true }, "DisplayName": { "title": "String", "type": "string", "description": "The display name", "maxLength": 128, "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The description", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The custom properties\nFormat is the following: \"CustomProperties\":\"[{\\\"Name\\\":\\\"ProxyHypervisorTrafficThroughConnector\\\",\\\"Value\\\":\\\"true\\\"},{\\\"Name\\\":\\\"ZoneUid\\\",\\\"Value\\\":\\\"4e1d7040-d830-4d97-8f94-342c03846f19\\\"}]\".", "nullable": true }, "UserPrincipalName": { "title": "String", "type": "string", "description": "The Microsoft Entra ID user principal name if 'IdentityProviderType' is AzureAD.", "nullable": true }, "UserSecret": { "title": "String", "type": "string", "description": "The Microsoft Entra ID user secret.", "nullable": true }, "UserSecretFormat": { "description": "Format of the UserSecret. Default is\nPlainText.", "default": "PlainText", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "UserSecretExpiryTime": { "title": "String", "type": "string", "description": "The Microsoft Entra ID user secret expiration time for the service account.\nIf it is not specified, will set secret as never expires.", "nullable": true }, "AccessTokenForBulk": { "title": "String", "type": "string", "description": "Get or set access token for Bulk token", "nullable": true }, "BulkTokenExpiryTime": { "title": "Int32", "type": "integer", "description": "Bulk token expiry time (in days, range: 2–180)", "format": "int32", "nullable": true } } }, "CreateUpgradeScheduleForMachinesRequestModel": { "title": "CreateUpgradeScheduleForMachinesRequestModel", "type": "object", "description": "Request object for creation of VDA upgrade schedule on a\nlist of machines.", "additionalProperties": false, "required": [ "MachineNameOrIds", "DurationInHours" ], "properties": { "MachineNameOrIds": { "title": "String[]", "type": "array", "description": "Machine list to create VDA upgrade schedules for.\nItem can be machine name or Id.", "items": { "title": "String", "type": "string" } }, "StartDateTimeUtc": { "title": "DateTime", "type": "string", "description": "UTC time to start the Vda upgrade. Must be a future time.\nIf set to null, the upgrade should be started at once.", "format": "date-time", "nullable": true }, "DurationInHours": { "title": "Int32", "type": "integer", "description": "Timeout duration in hours. Valid range is 1 to 24.", "format": "int32" }, "VdaWorkstationPackageUri": { "title": "String", "type": "string", "description": "Custom location to download the VDA Workstation package from. Currently, only network shares (specified using a UNC path) are supported.", "nullable": true }, "VdaServerPackageUri": { "title": "String", "type": "string", "description": "Custom location to download the VDA Server package from. Currently, only network shares (specified using a UNC path) are supported.", "nullable": true }, "LogoffOption": { "description": "Logoff option for VDA upgrade.", "nullable": true, "$ref": "#/components/schemas/LogoffOption" }, "VDAComponentsAndFeaturesRequestModel": { "description": "Selection of VDA upgrade components and features related to the Machines.", "nullable": true, "$ref": "#/components/schemas/VDAComponentsSelectionValidationRequestModel" }, "Reboot": { "title": "Boolean", "type": "boolean", "description": "Specify VDA needs to be rebooted before upgrade.", "nullable": true } } }, "CreateUpgradeScheduleRequestModel": { "title": "CreateUpgradeScheduleRequestModel", "type": "object", "description": "Request object for creation of VDA upgrade schedule on a\nmachine catalog or machine object.\nThere should not already be an upgrade schedule on the same object\nin UpgradeScheduled or UpgradeInProgress state.\nIn such cases, you can only update or cancel the schedule.", "additionalProperties": false, "required": [ "DurationInHours" ], "properties": { "StartDateTimeUtc": { "title": "DateTime", "type": "string", "description": "UTC time to start the Vda upgrade. Must be a future time.\nIf set to null, the upgrade should be started at once.", "format": "date-time", "nullable": true }, "DurationInHours": { "title": "Int32", "type": "integer", "description": "Timeout duration in hours. Valid range is 1 to 24.", "format": "int32" }, "VDAComponentsAndFeaturesRequestModel": { "description": "Selection of VDA upgrade components and features related to the Machine Catalog.", "nullable": true, "$ref": "#/components/schemas/VDAComponentsSelectionValidationRequestModel" }, "VdaWorkstationPackageUri": { "title": "String", "type": "string", "description": "Custom location to download the VDA Workstation package from. Currently, only network shares (specified using a UNC path) are supported.", "nullable": true }, "VdaServerPackageUri": { "title": "String", "type": "string", "description": "Custom location to download the VDA Server package from. Currently, only network shares (specified using a UNC path) are supported.", "nullable": true }, "ConcurrencyLevel": { "title": "Int32", "type": "integer", "description": "Limits the Concurrent upgrades that can happen at any time in Upgrade Window.", "format": "int32", "nullable": true }, "FailureThreshold": { "title": "Int32", "type": "integer", "description": "Limits the number of failures that can take place during a scheduled upgrade.", "format": "int32", "nullable": true }, "LogoffOption": { "description": "Logoff option for VDA upgrade.", "nullable": true, "$ref": "#/components/schemas/LogoffOption" }, "Reboot": { "title": "Boolean", "type": "boolean", "description": "Specify VDA needs to be rebooted before upgrade.", "nullable": true } } }, "CreateUserZonePreferenceModel": { "title": "CreateUserZonePreferenceModel", "type": "object", "description": "Request object for specifying user zone preference properties.", "additionalProperties": false, "required": [ "ZoneId", "Name" ], "properties": { "ZoneId": { "title": "String", "type": "string", "description": "Zone Id.", "minLength": 1, "example": "For example, c7b0d0a7-b53b-42e1-8f69-accebb407e2b" }, "Name": { "title": "String", "type": "string", "description": "Name of the user or user group. Could be SamName, FullName, SID or UPN", "minLength": 1, "example": "Name of the user or user group" } } }, "CreateZoneRequestModel": { "title": "CreateZoneRequestModel", "type": "object", "description": "Request object for creation of zones.", "additionalProperties": false, "required": [ "Name" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the zone. Each zone within a site must have a unique name. \nName is the only required property in creating a new zone.", "maxLength": 64, "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of the zone.", "maxLength": 512, "nullable": true }, "ResourceLocation": { "title": "String", "type": "string", "description": "Resource location associated with the zone.", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the Zone.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the newly created zone will be part of.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "CustomizedSettingsModel": { "title": "CustomizedSettingsModel", "type": "object", "description": "Model for a customized setting.", "additionalProperties": false, "properties": { "recommendationId": { "title": "String", "type": "string", "description": "Gets the recommendation ID that uses this setting.", "nullable": true }, "name": { "title": "String", "type": "string", "description": "Gets the name of the setting.", "nullable": true }, "value": { "title": "Object", "type": "object", "description": "Gets the customized value (null if using default).", "nullable": true }, "defaultValue": { "title": "Object", "type": "object", "description": "Gets the default value (read-only reference).", "nullable": true }, "modifiedTime": { "title": "String", "type": "string", "description": "Gets the last modified time of the customized value (null if using default).", "nullable": true }, "recommendation": { "title": "String", "type": "string", "description": "Gets the recommendation name associated with this rule.", "nullable": true } } }, "CustomReportDataResponseModel": { "title": "CustomReportDataResponseModel", "type": "object", "additionalProperties": false, "properties": { "CsvData": { "title": "String", "type": "string", "nullable": true }, "HtmlSummaryData": { "title": "String", "type": "string", "nullable": true }, "HtmlDetailsData": { "title": "String", "type": "string", "nullable": true } } }, "CustomReportDateRangeType": { "title": "CustomReportDateRangeType", "type": "string", "description": "", "x-enumNames": [ "All", "Last24Hours", "Last7Days", "Last4Weeks", "Custom" ], "enum": [ "All", "Last24Hours", "Last7Days", "Last4Weeks", "Custom" ] }, "CustomReportFormatType": { "title": "CustomReportFormatType", "type": "string", "description": "", "x-enumNames": [ "Html", "Csv", "Both" ], "enum": [ "Html", "Csv", "Both" ] }, "CustomReportInfoRequestModel": { "title": "CustomReportInfoRequestModel", "type": "object", "additionalProperties": false, "required": [ "CustomReportFormat", "CustomReportDateRange" ], "properties": { "StartDate": { "title": "String", "type": "string", "description": "End date of the report. When CustomReportDateRangeType is Custom, start date should be provided.", "nullable": true }, "EndDate": { "title": "String", "type": "string", "description": "End date of the report. When CustomReportDateRangeType is Custom, end date should be provided.", "nullable": true }, "CustomReportFormat": { "description": "Custom report format: csv/html/both", "$ref": "#/components/schemas/CustomReportFormatType" }, "CustomReportDateRange": { "description": "Report date range type: All/Last24Hours/Last7Days/Last4Weeks/Custom ", "$ref": "#/components/schemas/CustomReportDateRangeType" } } }, "CvadSecurityTypes": { "title": "CvadSecurityTypes", "type": "string", "description": "", "x-enumNames": [ "Unknown", "XenServer", "SCVMM", "VCenter", "Custom", "AWS", "WakeOnLAN", "AzureRM", "GoogleCloudPlatform", "CloudPlatform", "Nutanix" ], "enum": [ "Unknown", "XenServer", "SCVMM", "VCenter", "Custom", "AWS", "WakeOnLAN", "AzureRM", "GoogleCloudPlatform", "CloudPlatform", "Nutanix" ] }, "DailyCostItemResponseModel": { "title": "DailyCostItemResponseModel", "type": "object", "description": "The response model for the daily cost item.", "additionalProperties": false, "properties": { "UsageDate": { "title": "Int64", "type": "integer", "description": "The date of the usage.", "format": "int64" }, "ResourceCostItems": { "title": "IList`1", "type": "array", "description": "The cost of the resources.", "nullable": true, "items": { "$ref": "#/components/schemas/ResourceCostItemResponseModel" } } } }, "DailyCostResponseModelCollection": { "title": "DailyCostResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDailyCostItemResponseModel" }, { "type": "object", "description": "The response model for the daily cost of the machine catalog.", "additionalProperties": false } ] }, "DatabaseAuthenticationMode": { "title": "DatabaseAuthenticationMode", "type": "string", "description": "", "x-enumNames": [ "Windows", "SQLServer" ], "enum": [ "Windows", "SQLServer" ] }, "DatabaseChangePropertiesModel": { "title": "DatabaseChangePropertiesModel", "type": "object", "description": "Database change properties model.", "additionalProperties": false, "required": [ "DatabaseName", "DatabaseServerAddress", "ManualUpdateDatabase", "SkipWarning" ], "properties": { "DatabaseName": { "title": "String", "type": "string", "description": "Name of database", "minLength": 1 }, "DatabaseServerAddress": { "title": "String", "type": "string", "description": "Server address of database", "minLength": 1 }, "ManualUpdateDatabase": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the database should be created manually by scripts" }, "SkipWarning": { "title": "Boolean", "type": "boolean", "description": "Indicates whether ignore warnings where changing database" }, "Encryption": { "description": "Indicates the encryption level for the database connection.", "$ref": "#/components/schemas/DatabaseEncryption" }, "TrustServerCertificate": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to trust the server certificate when connecting to the database." }, "HostNameInCertificate": { "title": "String", "type": "string", "description": "The host name in the certificate when verifying the certificate of the database.", "nullable": true } } }, "DatabaseChangeScriptModel": { "title": "DatabaseChangeScriptModel", "type": "object", "description": "Response object for DatabaseChangeScript.", "additionalProperties": false, "properties": { "FileName": { "title": "String", "type": "string", "description": "The filename of the text file.", "nullable": true }, "Content": { "title": "String", "type": "string", "description": "The contents of the text file.", "nullable": true } } }, "DatabaseChangeScriptModelCollection": { "title": "DatabaseChangeScriptModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDatabaseChangeScriptModel" }, { "type": "object", "description": "Response object for collections of DatabaseChangeScriptModel.", "additionalProperties": false } ] }, "DatabaseChangeScriptPropertiesModel": { "title": "DatabaseChangeScriptPropertiesModel", "type": "object", "description": "Database change script properties model.", "additionalProperties": false, "required": [ "DatabaseName", "DatabaseServerAddress" ], "properties": { "DatabaseName": { "title": "String", "type": "string", "description": "Name of database", "minLength": 1 }, "DatabaseServerAddress": { "title": "String", "type": "string", "description": "Server address of database", "minLength": 1 } } }, "DatabaseEncryption": { "title": "DatabaseEncryption", "type": "string", "description": "The encryption level for the database connection.", "x-enumNames": [ "Optional", "Mandatory", "Strict" ], "enum": [ "Optional", "Mandatory", "Strict" ] }, "DatabaseResponseModel": { "title": "DatabaseResponseModel", "type": "object", "description": "Database response model.", "additionalProperties": false, "properties": { "DataStore": { "description": "Type of database.", "$ref": "#/components/schemas/DataStore" }, "DatabaseName": { "title": "String", "type": "string", "description": "Name of database", "nullable": true }, "DatabaseServerAddress": { "title": "String", "type": "string", "description": "Server address of database", "nullable": true }, "MirrorDatabaseServerAddress": { "title": "String", "type": "string", "description": "Mirror address of database", "nullable": true }, "CanChangeDatabase": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this database can be changed" }, "Encryption": { "description": "Indicates the encryption level for the database connection.", "nullable": true, "$ref": "#/components/schemas/DatabaseEncryption" }, "TrustServerCertificate": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to trust the server certificate when connecting to the database.", "nullable": true }, "HostNameInCertificate": { "title": "String", "type": "string", "description": "The host name in the certificate when verifying the certificate of the database.", "nullable": true } } }, "DatabaseResponseModelCollection": { "title": "DatabaseResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDatabaseResponseModel" }, { "type": "object", "description": "Response object for collections of DatabaseResponseModel.", "additionalProperties": false } ] }, "DatabaseServerEdition": { "title": "DatabaseServerEdition", "type": "string", "description": "", "x-enumNames": [ "Azure", "OnPrem" ], "enum": [ "Azure", "OnPrem" ] }, "DataDiskPersistence": { "title": "DataDiskPersistence", "type": "string", "description": "Indicates whether the data disk is persistent or non-persistent.", "x-enumNames": [ "Unknown", "Persistent", "NonPersistent" ], "enum": [ "Unknown", "Persistent", "NonPersistent" ] }, "DataStore": { "title": "DataStore", "type": "string", "description": "Types of DataStore.", "x-enumNames": [ "Unknown", "Site", "Logging", "Monitor" ], "enum": [ "Unknown", "Site", "Logging", "Monitor" ] }, "DelegatedAdminPermissionResponseModel": { "title": "DelegatedAdminPermissionResponseModel", "type": "object", "description": "Response object for a delegated admin permission.", "additionalProperties": false, "required": [ "Id", "Name", "IsReadOnly", "Operations" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the permission.\nNeeds to be made globally unique (perhaps add site id)", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the permission.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of the permission.", "nullable": true }, "IsReadOnly": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the permission is restricted to\nread-only operations.\nWas: ReadOnly" }, "Operations": { "title": "String[]", "type": "array", "description": "List of operations that the permission allows.", "items": { "title": "String", "type": "string" } } } }, "DeleteAdministratorConsequence": { "title": "DeleteAdministratorConsequence", "type": "string", "description": "", "x-enumNames": [ "Unknown", "NoRightsLost", "SomeRightsLost", "AllRightsLost", "CannotDeleteLastFullAdmin" ], "enum": [ "Unknown", "NoRightsLost", "SomeRightsLost", "AllRightsLost", "CannotDeleteLastFullAdmin" ] }, "DeliveryControllerDeleteScriptModel": { "title": "DeliveryControllerDeleteScriptModel", "type": "object", "description": "Response object for DeliveryControllerDeleteScript.", "additionalProperties": false, "properties": { "FileName": { "title": "String", "type": "string", "description": "The filename of the text file.", "nullable": true }, "Content": { "title": "String", "type": "string", "description": "The contents of the text file.", "nullable": true } } }, "DeliveryControllerDeleteScriptModelCollection": { "title": "DeliveryControllerDeleteScriptModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDeliveryControllerDeleteScriptModel" }, { "type": "object", "description": "Response object for collections of DeliveryControllerDeleteScriptModel.", "additionalProperties": false } ] }, "DeliveryControllerResponseModel": { "title": "DeliveryControllerResponseModel", "type": "object", "description": "Delivery Controller response model.", "additionalProperties": false, "properties": { "Sid": { "title": "String", "type": "string", "description": "The sid of the delivery controller", "nullable": true }, "Id": { "title": "String", "type": "string", "description": "The id(uuid) of the delivery controller", "nullable": true }, "MachineName": { "title": "String", "type": "string", "description": "The machine name of the delivery controller", "nullable": true }, "DnsName": { "title": "String", "type": "string", "description": "The dns name of the delivery controller", "nullable": true }, "ServiceHostId": { "title": "Guid", "type": "string", "description": "The service host id of the delivery controller", "format": "guid" }, "ControllerVersion": { "title": "String", "type": "string", "description": "The controller version of the delivery controller", "nullable": true }, "ControllerExternalVersion": { "title": "String", "type": "string", "description": "The external version of the delivery controller", "nullable": true }, "RegisteredDesktops": { "title": "Int32", "type": "integer", "description": "The number of registered desktops in the delivery controller", "format": "int32" }, "LastActivityTime": { "title": "String", "type": "string", "description": "The LastActivityTime of the delivery controller", "nullable": true }, "LastStartTime": { "title": "String", "type": "string", "description": "The LastStartTime of the delivery controller", "nullable": true }, "OSVersion": { "title": "String", "type": "string", "description": "The OSVersion of the delivery controller", "nullable": true }, "OSType": { "title": "String", "type": "string", "description": "The OSType of the delivery controller", "nullable": true }, "ServiceStatuses": { "title": "DeliveryControllerServiceStatusResponseModel[]", "type": "array", "description": "The service statuses of the delivery controller.", "nullable": true, "items": { "$ref": "#/components/schemas/DeliveryControllerServiceStatusResponseModel" } }, "ControllerState": { "description": "The State of the delivery controller", "$ref": "#/components/schemas/DeliveryControllerState" }, "LasUniqueEnvId": { "title": "String", "type": "string", "description": "Las unique env Id", "nullable": true }, "LasActivationStatus": { "description": "Las activation status", "$ref": "#/components/schemas/LasActivationStatus" }, "LasActivationExpiry": { "title": "String", "type": "string", "description": "Las activation expiry", "nullable": true }, "IsLasAware": { "title": "Boolean", "type": "boolean", "description": "Las Aware of current DDC\n ", "nullable": true }, "ZoneId": { "title": "String", "type": "string", "description": "The ID of the zone this zonable item belongs to", "nullable": true }, "ZonableItemId": { "title": "String", "type": "string", "description": "The Id of this zonable Item. This is a generic name to access non-generic properties", "nullable": true }, "ZonableItemType": { "description": "The type of Zonable item this is", "$ref": "#/components/schemas/ZonableItemType" }, "ZoneName": { "title": "String", "type": "string", "description": "The Zone's Name", "nullable": true }, "ZonableItemName": { "title": "String", "type": "string", "description": "Tthe name of this zonable Item", "nullable": true }, "ZonableItemDescription": { "title": "String", "type": "string", "description": "The description of this zonable Item", "nullable": true } } }, "DeliveryControllerResponseModelCollection": { "title": "DeliveryControllerResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDeliveryControllerResponseModel" }, { "type": "object", "description": "Response object for collections of DeliveryControllerResponseModel.", "additionalProperties": false } ] }, "DeliveryControllerServiceStatusResponseModel": { "title": "DeliveryControllerServiceStatusResponseModel", "type": "object", "description": "Service status response model of the delivery controller.", "additionalProperties": false, "properties": { "ServiceType": { "description": "Type of a service.", "$ref": "#/components/schemas/ControllerServiceType" }, "ServiceStatus": { "description": "Status of a service.", "$ref": "#/components/schemas/ControllerServiceStatus" } } }, "DeliveryControllerState": { "title": "DeliveryControllerState", "type": "string", "description": "Type of DeliveryController state", "x-enumNames": [ "Unknown", "Failed", "Off", "Transitioning", "Active" ], "enum": [ "Unknown", "Failed", "Off", "Transitioning", "Active" ] }, "DeliveryGroupAddApplicationsRequestModel": { "title": "DeliveryGroupAddApplicationsRequestModel", "type": "object", "description": "Request object for adding applications to a delivery group.", "additionalProperties": false, "properties": { "ExistingApplications": { "title": "PriorityRefRequestModel[]", "type": "array", "description": "List of existing applications to be associated with the\ndelivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/PriorityRefRequestModel" } }, "NewApplications": { "title": "CreateApplicationRequestModel[]", "type": "array", "description": "List of applications which should be created and associated\nwith the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/CreateApplicationRequestModel" } }, "ExistingApplicationGroups": { "title": "PriorityRefRequestModel[]", "type": "array", "description": "List of existing application groups to be associated with the\ndelivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/PriorityRefRequestModel" } } } }, "DeliveryGroupAddMachinesRequestModel": { "title": "DeliveryGroupAddMachinesRequestModel", "type": "object", "description": "Delivery group add machines request", "additionalProperties": false, "required": [ "MachineCatalog" ], "properties": { "MachineCatalog": { "title": "String", "type": "string", "description": "The machine catalog from which to add machines. May be an Id or name.", "minLength": 1, "example": "f254399c-6b4c-46fd-86e0-c03ade9135a2" }, "Count": { "title": "Int32", "type": "integer", "description": "The number of machines to assign from the machine catalog\nto the delivery group.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "AssignMachinesToUsers": { "title": "AssignMachineToUserRequestModel[]", "type": "array", "description": "List of specific machine assignments to users.", "nullable": true, "items": { "$ref": "#/components/schemas/AssignMachineToUserRequestModel" } } } }, "DeliveryGroupAssociationResponseModel": { "title": "DeliveryGroupAssociationResponseModel", "allOf": [ { "$ref": "#/components/schemas/RefResponseModel" }, { "type": "object", "description": "Response object for delivery group association.", "additionalProperties": false, "required": [ "Associated" ], "properties": { "Associated": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group was associated." }, "Priority": { "title": "Int32", "type": "integer", "description": "The priority of delivery group association.", "format": "int32", "nullable": true } } } ] }, "DeliveryGroupAssociationResponseModelCollection": { "title": "DeliveryGroupAssociationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDeliveryGroupAssociationResponseModel" }, { "type": "object", "description": "Collection type of DeliveryGroupAssociationResponseModel", "additionalProperties": false } ] }, "DeliveryGroupCriticalIssueType": { "title": "DeliveryGroupCriticalIssueType", "type": "string", "description": "Enum representing critical error types in a delivery group", "x-enumNames": [ "Unknown", "Broken" ], "enum": [ "Unknown", "Broken" ] }, "DeliveryGroupDetailResponseModel": { "title": "DeliveryGroupDetailResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,Delivering,DeliveryType,Description,DesktopsDisconnected,DesktopsUnregistered,Enabled,InMaintenanceMode,IsRemotePC,MachineLogOnType,MinimumFunctionalLevel,Name,FullName,PublishedName,SessionSupport,SharingKind,DefaultDesktopIconId. \n Response object for details of a delivery group.\n ", "allOf": [ { "$ref": "#/components/schemas/DeliveryGroupResponseModel" }, { "type": "object", "description": "Response object for details of a delivery group.", "additionalProperties": false, "required": [ "DesktopsInUse", "DesktopsNeverRegistered", "DesktopsPreparing", "MachinesInMaintenanceMode", "MachineOperatingSystems", "MachineType", "OffMachines", "RegisteredMachines", "SecureIcaRequired", "TotalApplicationGroups", "TotalMachines" ], "properties": { "AppAccessPolicy": { "description": "Policy controlling access to all applications delivered from a\ndelivery group.\nCHANGE: add", "nullable": true, "$ref": "#/components/schemas/AppAccessPolicyResponseModel" }, "AppProtectionKeyLoggingRequired": { "title": "Boolean", "type": "boolean", "description": "Specifies whether key logging app protection is required.", "nullable": true }, "AppProtectionScreenCaptureRequired": { "title": "Boolean", "type": "boolean", "description": "Specifies whether screen capture app protection is required.", "nullable": true }, "AutomaticPowerOnForAssigned": { "title": "Boolean", "type": "boolean", "description": "Whether assigned (Private)\nmachines in the delivery group should be automatically\npowered-on at the start of peak time periods." }, "AutomaticPowerOnForAssignedDuringPeak": { "title": "Boolean", "type": "boolean", "description": "Whether assigned (Private) machines in the\ndelivery group should be automatically powered-on throughout peak\ntime periods." }, "AutoScaleEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether auto-scale is enabled for the delivery group.", "nullable": true }, "RestrictAutoscaleTag": { "description": "Specifies the tag used to restrict autoscale.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "ColorDepth": { "description": "Specifies the color depth that the ICA session should use\nfor connections to machines in this group.", "$ref": "#/components/schemas/ColorDepth" }, "DefaultDesktopPublishedName": { "title": "String", "type": "string", "description": "Default published name to use for desktops published from the delivery group.\nChange: Add", "nullable": true }, "DesktopsInUse": { "title": "Int32", "type": "integer", "description": "Number of machines in the delivery group which are currently in-use.", "format": "int32" }, "DesktopsNeverRegistered": { "title": "Int32", "type": "integer", "description": "Number of machines in the delivery group which have never successfully registered.", "format": "int32" }, "DesktopsPreparing": { "title": "Int32", "type": "integer", "description": "Number of machines in the delivery group which are preparing for a connection.", "format": "int32" }, "HdxSslEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether connections to machines in the delivery group will\nuse SSL.\nCHANGE: add:", "nullable": true }, "LingerSettings": { "description": "Session linger settings for sessions launched on machines\nin the delivery group.", "nullable": true, "$ref": "#/components/schemas/FastApplicationSettingsResponseModel" }, "PowerOffDelayMinutes": { "title": "Int32", "type": "integer", "description": "Delay before machines are powered off, when scaling down. Specified\nin minutes. Applies only to multi-session machines.", "format": "int32", "nullable": true }, "MachineCost": { "title": "Double", "type": "number", "description": "Indicates the estimated per-hour cost for machines in the delivery\ngroup, as set by the administrator.", "format": "double", "nullable": true }, "MachinesInMaintenanceMode": { "title": "Int32", "type": "integer", "description": "Number of machines in the delivery group which are in maintenance mode.", "format": "int32" }, "MachineOperatingSystems": { "title": "NameValueIntPairModel[]", "type": "array", "description": "List of operating systems of machines in the delivery group,\nalong with a count of how many machines use each OS.\nCHANGE: was\npublic IDictionary MachineOperatingSystems { get; set; }", "items": { "$ref": "#/components/schemas/NameValueIntPairModel" } }, "MachineType": { "description": "Type of the machines in the delivery group, indicating\nwhether the machines can be power managed.", "$ref": "#/components/schemas/MachineType" }, "OffMachines": { "title": "Int32", "type": "integer", "description": "Number of machines in the delivery group which are currently powered off.", "format": "int32" }, "OffPeakBufferSizePercent": { "title": "Int32", "type": "integer", "description": "The percentage of machines in the delivery group that should be kept\navailable in an idle state outside peak hours.", "format": "int32" }, "OffPeakDisconnectAction": { "description": "The action to be performed after a configurable period of a user\nsession disconnecting outside peak hours.", "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session disconnects outside peak hours.", "format": "int32" }, "OffPeakExtendedDisconnectAction": { "description": "The action to be performed after a second configurable period of a\nuser session disconnecting outside peak hours.", "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakExtendedDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the second configured action should be\nperformed after a user session disconnects outside peak hours.", "format": "int32" }, "OffPeakLogOffAction": { "description": "The action to be performed after a configurable period of a user\nsession ending outside peak hours.", "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakLogOffTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session ends outside peak hours.", "format": "int32" }, "PeakAutoscaleAssignedPowerOnIdleTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action is performed on an assigned machine previously\nstarted by autoscale that subsequently remains unused.", "format": "int32", "nullable": true }, "PeakAutoscaleAssignedPowerOnIdleAction": { "description": "The action to be performed on an assigned machine started by Autoscale\nif that machine then remains unused for a defined period of time.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakBufferSizePercent": { "title": "Int32", "type": "integer", "description": "The percentage of machines in the delivery group that should be kept\navailable in an idle state in peak hours.", "format": "int32" }, "PeakDisconnectAction": { "description": "The action to be performed after a configurable period of a user\nsession disconnecting in peak hours.", "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the second configured action should be\nperformed after a user session disconnects in peak hours.", "format": "int32" }, "PeakExtendedDisconnectAction": { "description": "The action to be performed after a configurable period of a user\nsession ending in peak hours.", "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakExtendedDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the second configured action should be\nperformed after a user session disconnects in peak hours.", "format": "int32" }, "PeakLogOffAction": { "description": "The action to be performed after a configurable period of a user\nsession ending in peak hours.", "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakLogOffTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session ends in peak hours.", "format": "int32" }, "DisconnectPeakIdleSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which an idle session\nbelonging to the delivery group is disconnected during peak time.", "format": "int32" }, "DisconnectOffPeakIdleSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which an idle session\nbelonging to the delivery group is disconnected during off-peak time.", "format": "int32" }, "LogoffPeakDisconnectedSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which a disconnected session\nbelonging to the delivery group is terminated during peak time.", "format": "int32" }, "LogoffOffPeakDisconnectedSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which a disconnected session\nbelonging to the delivery group is terminated during off-peak time.", "format": "int32" }, "AutoscaleScaleDownActionDuringPeak": { "description": "Specifies the action to be used for Autoscale to scale down the number of machines in this desktop group during peak.\nPossible values are: Shutdown and Suspend.", "nullable": true, "$ref": "#/components/schemas/AutoscaleScaleDownAction" }, "AutoscaleScaleDownActionDuringOffPeak": { "description": "Specifies the action to be used for Autoscale to scale down the number of machines in this desktop group during off-peak.\nPossible values are: Shutdown and Suspend.", "nullable": true, "$ref": "#/components/schemas/AutoscaleScaleDownAction" }, "PrelaunchSettings": { "description": "Prelaunch settings for users with resources published from\nthe delivery group.", "nullable": true, "$ref": "#/components/schemas/FastApplicationSettingsResponseModel" }, "PowerTimeSchemes": { "title": "PowerTimeSchemeResponseModel[]", "type": "array", "description": "Power management time schemes. No two schemes will cover the same\nday of the week.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use ", "nullable": true, "items": { "$ref": "#/components/schemas/PowerTimeSchemeResponseModel" } }, "ProtocolPriority": { "title": "ProtocolType[]", "type": "array", "description": "A list of protocols in the order in which they will be\nattempted for use during connection.", "nullable": true, "items": { "$ref": "#/components/schemas/ProtocolType" } }, "RegisteredMachines": { "title": "Int32", "type": "integer", "description": "Number of machines in the delivery group that have registered.", "format": "int32" }, "SecureIcaRequired": { "title": "Boolean", "type": "boolean", "description": "Whether HDX connections to machines in the delivery group\nrequire the use of the SecureICA protocol." }, "SettlementPeriodBeforeAutoShutdownSeconds": { "title": "Int32", "type": "integer", "description": "Time after a session ends during which automatic shutdown\nrequests (for example, shutdown after use, idle pool\nmanagement) are deferred. Any outstanding shutdown request\ntakes effect after the settlement period expires. This is\ntypically used to configure time to allow logoff scripts\nto complete.", "format": "int32" }, "SettlementPeriodBeforeUseSeconds": { "title": "Int32", "type": "integer", "description": "Idle period before a machine can be selected to host a new\nsession after registration or the end of a previous\nsession. This is typically used to allow a machine to\nbecome idle following processing associated with start-up\nor logoff actions. A machine may still be selected during\nthe idle period if no other machine is available for\nimmediate use.", "format": "int32" }, "ShutdownDesktopsAfterUse": { "title": "Boolean", "type": "boolean", "description": "Whether machines in this delivery group should be\nautomatically shut down when each user session completes.", "nullable": true }, "SimpleAccessPolicy": { "description": "Simplified access policy for connections to the delivery group.\nCHANGE: was\npublic SimplifiedAccessPolicyResponseModel[] AccessPolicies { get; set; }\n\nIf the delivery group does not have exactly 1 access policy, this\nproperty will be null.\nIf the delivery group has exactly 1 access policy, BUT the access\npolicy is Enabled==false, this property will be null.\nIf the delivery group has exactly 1 access policy, BUT the access\npolicy cannot be represented by the SimplifiedAccessPolicyResponseModel,\nthis property will be null.\n-> For example, if any of the Excluded*Enabled properties are true.\n-> For example, if any of the IncludedClient*FilterEnabled properties are true.\n-> For example, if IncludedDesktopGroups or IncludedDesktopGroupFilter are true.\n\nThe intent is to represent access control rules in the same simplified\nmodel as is exposed through Studio. Customers who need more control\ncan use the low-level PowerShell API or the AdvancedAccessPolicies API\nto access the full expressiveness of the access control model.\n\nIf Studio encounters a delivery group with this property returning null,\nit should switch into a mode that informs the admin they must configure\naccess control through the PowerShell API since it cannot be represented\nin the UI.", "nullable": true, "$ref": "#/components/schemas/SimplifiedAccessPolicyResponseModel" }, "AdvancedAccessPolicy": { "title": "AdvancedAccessPolicyResponseModel[]", "type": "array", "description": "List of Advanced access policy for connections to the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/AdvancedAccessPolicyResponseModel" } }, "StoreFrontServersForHostedReceiver": { "title": "StoreFrontServerResponseModel[]", "type": "array", "description": "List of StoreFront server addresses to configure within hosted\nreceivers that are delivered from the delivery group.\nCHANGE: was\npublic string[] StoreFronts", "nullable": true, "items": { "$ref": "#/components/schemas/StoreFrontServerResponseModel" } }, "TimeZone": { "title": "String", "type": "string", "description": "The time zone in which this delivery group's machines reside.", "nullable": true }, "TotalApplicationGroups": { "title": "Int32", "type": "integer", "description": "Total number of application groups associated with the delivery group.", "format": "int32" }, "TotalMachines": { "title": "Int32", "type": "integer", "description": "Total number of machines in the delivery group.", "format": "int32" }, "TurnOnAddedMachines": { "title": "Boolean", "type": "boolean", "description": "Whether to attempt to power on machines when they are added\nto the delivery group.\nwas TurnOnAddedMachine", "nullable": true }, "UnassignedMachines": { "title": "Int32", "type": "integer", "description": "Number of unassigned machines in the delivery group.", "format": "int32", "nullable": true }, "UsedByGroupPolicy": { "title": "Boolean", "type": "boolean", "description": "Check if desktop group is used by group policy.", "nullable": true }, "VdaVersions": { "title": "NameValueIntPairModel[]", "type": "array", "description": "List of the versions, and count of each version, of VDAs within the delivery group.\nCHANGE: was\npublic IDictionary VdaVersions { get; set; }", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueIntPairModel" } }, "ZonePreferences": { "title": "ZonePreference[]", "type": "array", "description": "Ordered list of zone preferences to be applied when launching\nresources from this delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/ZonePreference" } }, "LimitSecondsToForceLogOffUserDuringPeak": { "title": "Int32", "type": "integer", "description": "Represents the number of seconds that must elapsed before\nthe active sessions on the draining machines belonging to\nthe delivery group are logged off, during peak time.", "format": "int32", "nullable": true }, "LimitSecondsToForceLogOffUserDuringOffPeak": { "title": "Int32", "type": "integer", "description": "Represents the number of seconds that must elapsed before\nthe active sessions on the draining machines belonging\nto the delivery group are logged off, during off-peak.", "format": "int32", "nullable": true }, "RestrictAutoscaleMinIdleUntaggedPercentDuringPeak": { "title": "Int32", "type": "integer", "description": "Represents the percentage that the number of untagged single-session machines\nin an idle state, or for multi-session machines, the untagged available\nload capacity must fall below before Autoscale powers on and manages 'tagged'\nmachines, as per policy, in peak time. If the number of untagged machines in\nan idle state, or the untagged available load capacity goes above this threshold value,\nAutoscale will attempt to shut down 'tagged' machines.", "format": "int32", "nullable": true }, "RestrictAutoscaleMinIdleUntaggedPercentDuringOffPeak": { "title": "Int32", "type": "integer", "description": "Represents the percentage that the number of untagged single-session machines in an idle state,\nor for multi-session machines, the untagged available load capacity must fall below\nbefore Autoscale powers on and manages 'tagged' machines, as per policy, in off-peak.\nIf the number of untagged machines in an idle state, or the untagged available load capacity\ngoes above this threshold value, Autoscale will attempt to shut down 'tagged' machines.", "format": "int32", "nullable": true }, "LogOffWarningMessage": { "title": "String", "type": "string", "description": "The warning message to display to users in active sessions prior to logging off users,\nwhether in peak time or off-peak.", "nullable": true }, "LogOffWarningTitle": { "title": "String", "type": "string", "description": "The title of the warning message dialog.", "nullable": true }, "LoadBalanceType": { "description": "Indicates whether to use vertical scaling when\nfinding an RDS machine in the desktop group for a session launch.\nVertical scaling would saturate machines in the current pool\nrather than send sessions to the least loaded machines.\nThis would be a trade in performance vs. cost, where vertical scaling would\nbe less costly.", "nullable": true, "$ref": "#/components/schemas/LoadBalanceType" }, "AutoscaleLogOffReminderEnabled": { "title": "Boolean", "type": "boolean", "description": "Boolean value indicating whether the warning messages should be\nsent on an interval to nudge a logoff\nshould be sent on an interval when autoscale is enabled.", "nullable": true }, "AutoscaleLogOffReminderIntervalSecondsOffPeak": { "title": "Int32", "type": "integer", "description": "Represents the time interval at which messages are sent to the user during off peak time\nwhen Autoscale is enabled.\nThis message will nudge users to log off instead of forcibly logging them off.", "format": "int32", "nullable": true }, "AutoscaleLogOffReminderIntervalSecondsPeak": { "title": "Int32", "type": "integer", "description": "Represents the time interval at which messages are sent to the user during peak time\nwhen autoscale is enabled.\nThis message will nudge users to log off instead of forcibly logging them off.", "format": "int32", "nullable": true }, "AutoscaleLogOffReminderMessage": { "title": "String", "type": "string", "description": "Notification message to display to users in active sessions\nbelonging to machines needed by Autoscale for shutdown.", "nullable": true }, "AutoscaleLogOffReminderTitle": { "title": "String", "type": "string", "description": "Notification message dialog title displayed\nwhen Autoscale issues a logoff reminder request.", "nullable": true }, "AutoscaleGroupPlugins": { "title": "AutoscaleGroupPluginModel[]", "type": "array", "description": "Autoscale group plugins.", "nullable": true, "items": { "$ref": "#/components/schemas/AutoscaleGroupPluginModel" } } } } ] }, "DeliveryGroupNonCriticalIssueType": { "title": "DeliveryGroupNonCriticalIssueType", "type": "string", "description": "Enum representing non-critical warning types in a delivery group", "x-enumNames": [ "Unknown", "InvalidLicense", "HasFaultedDesktops", "LocalHostCacheNotActivated" ], "enum": [ "Unknown", "InvalidLicense", "HasFaultedDesktops", "LocalHostCacheNotActivated" ] }, "DeliveryGroupResponseModel": { "title": "DeliveryGroupResponseModel", "type": "object", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,Delivering,DeliveryType,Description,DesktopsDisconnected,DesktopsUnregistered,Enabled,InMaintenanceMode,IsRemotePC,MachineLogOnType,MinimumFunctionalLevel,Name,FullName,PublishedName,SessionSupport,SharingKind,DefaultDesktopIconId. \n Response object for a delivery group.\n ", "additionalProperties": false, "required": [ "Id", "Delivering", "DeliveryType", "DesktopsAvailable", "DesktopsDisconnected", "DesktopsFaulted", "DesktopsUnregistered", "Enabled", "HasBeenPromoted", "InMaintenanceMode", "IsBroken", "IsRemotePC", "MinimumFunctionalLevel", "Name", "RequireUserHomeZone", "Scopes", "SessionCount", "SessionSupport", "SharingKind", "TotalApplications", "TotalDesktops", "ApplicationGroupCompatibility" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Globally unique identifier of the delivery group.", "minLength": 1 }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED.` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED." }, "UserManagement": { "description": "Indicates whether users are managed in the Citrix Cloud Library, or\nwithin Studio.", "$ref": "#/components/schemas/UserManagementModel" }, "Delivering": { "description": "Types of resources currently being delivered from\nthe delivery group.\nCHANGE: was:\npublic DeliveredItemType Delivering { get; set; }", "$ref": "#/components/schemas/DeliveryKind" }, "DeliveryType": { "description": "Types of resources that may be delivered from the\ndelivery group.", "$ref": "#/components/schemas/DeliveryKind" }, "Description": { "title": "String", "type": "string", "description": "A description for this delivery group useful for administrators\nof the site.", "nullable": true }, "DesktopsAvailable": { "title": "Int32", "type": "integer", "description": "Number of machines in the delivery group which are available\nto launch sessions on.", "format": "int32" }, "DesktopsDisconnected": { "title": "Int32", "type": "integer", "description": "Number of desktops in the delivery group which have\ndisconnected sessions.", "format": "int32" }, "DesktopsFaulted": { "title": "Int32", "type": "integer", "description": "Number of desktops in the delivery group which are in a\nfaulted state.", "format": "int32" }, "DesktopsUnregistered": { "title": "Int32", "type": "integer", "description": "Number of desktops in the delivery group which have failed\nto register.", "format": "int32" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group is enabled. All resources published\non a disabled delivery group do not appear to users." }, "HasBeenPromoted": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group was previously promoted from a lower\nMinimumFunctionalLevel." }, "HasBeenPromotedFrom": { "description": "If HasBeenPromoted is `true`, this is the\nprevious MinimumFunctionalLevel.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group is in maintenance mode;\na delivery group in maintenance mode will not allow users to\nconnect or reconnect to machines in the delivery group." }, "IsBroken": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group is currently in a \"Broken\" state." }, "IsRemotePC": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group is comprised of RemotePC VDAs." }, "MachineLogOnType": { "description": "The login type for machines in this desktop group.", "$ref": "#/components/schemas/MachineLogOnType" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "MinimumFunctionalLevel": { "description": "The minimum functional level of machines in the delivery group.", "$ref": "#/components/schemas/FunctionalLevel" }, "Name": { "title": "String", "type": "string", "description": "Simple administrative name of delivery group within parent admin folder (if any). This\nproperty is not guaranteed unique across all catalogs.", "minLength": 1 }, "FullName": { "title": "String", "type": "string", "description": "Unique administrative name of delivery group.", "nullable": true }, "PublishedName": { "title": "String", "type": "string", "description": "The name of the desktop group as it is to appear to the user in StoreFront.", "nullable": true }, "PolicySetGuid": { "title": "Guid", "type": "string", "description": "The Guid of the policy set that is assigned to this desktop group. If the value is Guid.Empty, there is\nno policy set assigned to the desktop group.", "format": "guid" }, "ProductCode": { "title": "String", "type": "string", "description": "The product code of the delivery group.", "nullable": true }, "LicenseModel": { "description": "The license model of the delivery group.", "nullable": true, "$ref": "#/components/schemas/LicenseModel" }, "RequireUserHomeZone": { "title": "Boolean", "type": "boolean", "description": "Whether the resources from this delivery group are required to\nlaunch within the user's home zone." }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "Administrative scopes which the delivery group is part of.", "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "Tenants": { "title": "RefResponseModel[]", "type": "array", "description": "The tenant(s) that the delivery group is assigned to. If `null`,\nthe delivery group is not assigned to tenants, and may be used by\nany tenant, including future added tenants.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "Tags": { "title": "String[]", "type": "array", "description": "The tags directly associated with the delivery group.", "nullable": true, "items": { "title": "String", "type": "string" } }, "SessionCount": { "title": "Int32", "type": "integer", "description": "Number of sessions currently running on machines in the delivery group.", "format": "int32" }, "SessionSupport": { "description": "Type of session support provided by machines in the delivery group.", "$ref": "#/components/schemas/SessionSupport" }, "SharingKind": { "description": "Sharing mode for machines in the delivery group.\nCHANGE: was:\npublic DesktopKind DesktopKind { get; set; }", "$ref": "#/components/schemas/SharingKind" }, "TotalApplications": { "title": "Int32", "type": "integer", "description": "Total number of applications published on the delivery group.", "format": "int32" }, "TotalDesktops": { "title": "Int32", "type": "integer", "description": "Total number of desktops in the delivery group.", "format": "int32" }, "ApplicationGroupCompatibility": { "description": "Indicates compatibility of the delivery group with application groups.", "$ref": "#/components/schemas/AppGroupCompatibility" }, "ApplicationCompatibility": { "description": "Indicates compatibility of the delivery group with applications.", "$ref": "#/components/schemas/AppOrDesktopCompatibility" }, "DesktopCompatibility": { "description": "Indicates compatibility of the delivery group with desktops.", "$ref": "#/components/schemas/AppOrDesktopCompatibility" }, "RequiredSleepCapability": { "description": "The sleep capability of this desktop group.", "nullable": true, "$ref": "#/components/schemas/RequiredSleepCapability" }, "AdminFolder": { "description": "The folder in which the machinecatalog resides.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "IsPowerManaged": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the machines in the delivery group are power-managed.\nNOTE: I used to think that MachineType==Virtual meant the same thing\nas \"power-managed\"; however that's not the case. A machine is power-\nmanaged if it is Virtual OR if it is RemotePC with a hypervisor\nconnection (which will still have MachineType==Physical)." }, "AutoscalingEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether machines in this desktop group can be Autoscaled." }, "ReuseMachinesWithoutShutdownInOutage": { "title": "Boolean", "type": "boolean", "description": "Whether machines will be reused without a shutdown in case of an outage." }, "TotalDesktopsOfSuspend": { "title": "Int32", "type": "integer", "description": "Total number of suspend-capable desktops in the delivery group.", "format": "int32", "nullable": true }, "DefaultDesktopIconId": { "title": "String", "type": "string", "description": "Default icon to use for desktops published from the delivery group.\nwas IconUid", "nullable": true }, "CriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "List of critical issues associated with the delivery group", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfDeliveryGroupCriticalIssueType" } }, "NonCriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "List of non-critical issues associated with the delivery group", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfDeliveryGroupNonCriticalIssueType" } } } }, "DeliveryGroupResponseModelCollection": { "title": "DeliveryGroupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDeliveryGroupResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "DeliveryGroupSearchFilterGroupRequestModel": { "title": "DeliveryGroupSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for applications", "additionalProperties": false, "properties": { "SearchFilterGroupType": { "description": "The type of search filter group", "$ref": "#/components/schemas/DeliveryGroupSearchFilterGroupType" }, "SearchFilters": { "title": "DeliveryGroupSearchFilterRequestModel[]", "type": "array", "description": "The search filters in search filter group", "nullable": true, "items": { "$ref": "#/components/schemas/DeliveryGroupSearchFilterRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/DeliveryGroupSearchFilterGroupsType" }, "SearchFilterGroups": { "title": "DeliveryGroupSearchFilterGroupRequestModel[]", "type": "array", "description": "The search filter group in search filter groups", "nullable": true, "items": { "$ref": "#/components/schemas/DeliveryGroupSearchFilterGroupRequestModel" } } } }, "DeliveryGroupSearchFilterGroupsType": { "title": "DeliveryGroupSearchFilterGroupsType", "type": "string", "description": "The search filter groups type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "DeliveryGroupSearchFilterGroupType": { "title": "DeliveryGroupSearchFilterGroupType", "type": "string", "description": "The search filter group type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "DeliveryGroupSearchFilterRequestModel": { "title": "DeliveryGroupSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for delivery groups.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/DeliveryGroupSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true, "example": "For example, test" }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "DeliveryGroupSearchProperty": { "title": "DeliveryGroupSearchProperty", "type": "string", "description": "Delivery Group properties can be used for advanced deliveryGroup searches.", "x-enumNames": [ "Uid", "Description", "DeliveryType", "Enabled", "InMaintenanceMode", "IsRemotePC", "MachineLogOnType", "Name", "ProductCode", "SessionSupport", "TotalApplications", "SharingKind", "Tags" ], "enum": [ "Uid", "Description", "DeliveryType", "Enabled", "InMaintenanceMode", "IsRemotePC", "MachineLogOnType", "Name", "ProductCode", "SessionSupport", "TotalApplications", "SharingKind", "Tags" ] }, "DeliveryGroupSearchRequestModel": { "title": "DeliveryGroupSearchRequestModel", "type": "object", "description": "Request model for defining delivery group search criteria.", "additionalProperties": false, "properties": { "AdminFolder": { "title": "String", "type": "string", "description": "Admin folder in which to search for the delivery group.", "nullable": true, "example": "Name of an admin folder" }, "IncludeSubFolders": { "title": "Boolean", "type": "boolean", "description": "Whether to include subfolders of the\nAdminFolder in the search for the\ndelivery groups.", "default": true, "nullable": true }, "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the deliveryGroup.", "nullable": true, "example": "For example, name of a deliveryGroup" }, "SearchFilters": { "title": "DeliveryGroupSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/DeliveryGroupSearchFilterRequestModel" } }, "SortCriteria": { "description": "Sort criteria for the results.", "nullable": true, "$ref": "#/components/schemas/DeliveryGroupSortCriteriaRequestModel" }, "SearchFilterGroups": { "title": "DeliveryGroupSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/DeliveryGroupSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/DeliveryGroupSearchFilterGroupsType" }, "IssueFilterType": { "description": "Indicates the type of issue filter to apply when searching for delivery groups.", "$ref": "#/components/schemas/IssueSearchFilterType" } } }, "DeliveryGroupsFtaRequestModel": { "title": "DeliveryGroupsFtaRequestModel", "type": "object", "description": "Action Error class.", "additionalProperties": false, "properties": { "DeliveryGroups": { "title": "String[]", "type": "array", "description": "The delivery groups' name or id.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "DeliveryGroupSortCriteriaRequestModel": { "title": "DeliveryGroupSortCriteriaRequestModel", "type": "object", "description": "DeliveryGroup sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/DeliveryGroupSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "DeliveryGroupTestResponseModel": { "title": "DeliveryGroupTestResponseModel", "type": "object", "description": "Response object for a delivery group test result.", "additionalProperties": false, "required": [ "DeliveryGroup", "NumPassed", "NumWarnings", "NumFailures" ], "properties": { "DeliveryGroup": { "description": "The delivery group upon which the test was run.", "$ref": "#/components/schemas/RefResponseModel" }, "NumPassed": { "title": "Int32", "type": "integer", "description": "The number of tests that passed.", "format": "int32" }, "NumWarnings": { "title": "Int32", "type": "integer", "description": "The number of warnings that were found.", "format": "int32" }, "NumFailures": { "title": "Int32", "type": "integer", "description": "The number of tests that failed.", "format": "int32" }, "TestReport": { "description": "The detailed test report, only included when specifically requested in the API call.", "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } }, "DeliveryKind": { "title": "DeliveryKind", "type": "string", "description": "Types of resources delivered from a delivery group.", "x-enumNames": [ "Unknown", "DesktopsOnly", "DesktopsAndApps", "AppsOnly" ], "enum": [ "Unknown", "DesktopsOnly", "DesktopsAndApps", "AppsOnly" ] }, "DeregistrationReason": { "title": "DeregistrationReason", "type": "string", "description": "Reasons why a machine may have deregistered from a broker.", "x-enumNames": [ "Unknown", "AgentShutdown", "AgentSuspended", "AgentRequested", "IncompatibleVersion", "AgentAddressResolutionFailed", "AgentNotContactable", "AgentWrongActiveDirectoryOU", "EmptyRegistrationRequest", "MissingRegistrationCapabilities", "MissingAgentVersion", "InconsistentRegistrationCapabilities", "NotLicensedForFeature", "OSNotCompatibleWithDdc", "VMNotCompatibleWithDdc", "UnsupportedCredentialSecurityVersion", "InvalidRegistrationRequest", "SingleMultiSessionMismatch", "FunctionalLevelTooLowForCatalog", "FunctionalLevelTooLowForDesktopGroup", "PowerOff", "DesktopRestart", "DesktopRemoved", "AgentRejectedSettingsUpdate", "SendSettingsFailure", "SessionAuditFailure", "SessionPrepareFailure", "ContactLost", "SettingsCreationFailure", "UnknownError", "BrokerRegistrationLimitReached", "RegistrationStateMismatch", "UnexpectedAgentShutdown", "MachineInRegistrationSinBin" ], "enum": [ "Unknown", "AgentShutdown", "AgentSuspended", "AgentRequested", "IncompatibleVersion", "AgentAddressResolutionFailed", "AgentNotContactable", "AgentWrongActiveDirectoryOU", "EmptyRegistrationRequest", "MissingRegistrationCapabilities", "MissingAgentVersion", "InconsistentRegistrationCapabilities", "NotLicensedForFeature", "OSNotCompatibleWithDdc", "VMNotCompatibleWithDdc", "UnsupportedCredentialSecurityVersion", "InvalidRegistrationRequest", "SingleMultiSessionMismatch", "FunctionalLevelTooLowForCatalog", "FunctionalLevelTooLowForDesktopGroup", "PowerOff", "DesktopRestart", "DesktopRemoved", "AgentRejectedSettingsUpdate", "SendSettingsFailure", "SessionAuditFailure", "SessionPrepareFailure", "ContactLost", "SettingsCreationFailure", "UnknownError", "BrokerRegistrationLimitReached", "RegistrationStateMismatch", "UnexpectedAgentShutdown", "MachineInRegistrationSinBin" ] }, "DesktopCondition": { "title": "DesktopCondition", "type": "string", "description": "Desktop condition values, indicating warnings.", "x-enumNames": [ "Unknown", "CPU", "ICALatency", "UPMLogonTime" ], "enum": [ "Unknown", "CPU", "ICALatency", "UPMLogonTime" ] }, "DesktopGroupNameCheckRequestModel": { "title": "DesktopGroupNameCheckRequestModel", "type": "object", "description": "Request Model for Checking Desktop Group Name with Admin Folder", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Desktop Group Name with Admin Folder", "nullable": true } } }, "DesktopRequestModel": { "title": "DesktopRequestModel", "type": "object", "description": "Request object for creation of a published desktop.\nWhen the delivery group type=DesktopsOnly and SharingKind=Private,\nthis turns into New-BrokerAssignmentPolicyRule.\nWhen type=(DesktopsOnly or DesktopsAndApps) and SharingKind=Shared,\nthis turns into New-BrokerEntitlementPolicyRule.\nWhen type=AppsOnly and SharingKind=Private, it is not allowed to\nadd desktops to a delivery group.\nThe combination of type=AppsAndDesktops and SharingKind=Private is\nalso not allowed.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Identifier of an existing desktop associated with\nthe delivery group.", "nullable": true, "example": "Id of a desktop" }, "ColorDepth": { "description": "Color depth to use for desktop sessions to machines\nin the delivery group.", "nullable": true, "$ref": "#/components/schemas/ColorDepth" }, "Description": { "title": "String", "type": "string", "description": "Specifies an optional description of the new desktop.\nThe text may be visible to the end user, for example, as a\ntooltip associated with the desktop within receiver.", "nullable": true, "example": "Description of the desktop" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the published desktop is enabled.\nA disabled desktop is ignored when determining which\ndesktops are available for a user.", "nullable": true }, "ExcludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the ExcludedUsers filter is\nenabled. If the filter is disabled then any user entries in\nthe filter are ignored when determining which desktops are\navailable for a user.", "nullable": true }, "ExcludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the excluded users filter of the desktop; that is,\nthe users and groups who are explicitly denied access to the\npublished desktop.", "nullable": true, "example": [ "Name of an excludedUser" ], "items": { "title": "String", "type": "string" } }, "Icon": { "title": "String", "type": "string", "description": "Specifies the image data of the icon used to display the published\ndesktop to the user, and of assigned desktop(s) in the case\nwhere SharingKind\nis equal to Private.", "nullable": true, "example": "Data of the icon" }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery group's access\npolicy is implicitly granted an entitlement to the published\ndesktop.", "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the included users filter of the desktop; that is,\nthe users and groups who are explicitly granted access to the\npublished desktop.", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } }, "LeasingBehavior": { "description": "Defines the desired connection leasing behavior applied to\ndesktop sessions.", "nullable": true, "$ref": "#/components/schemas/LeasingBehavior" }, "MaxDesktops": { "title": "Int32", "type": "integer", "description": "The number of machines from the delivery group which a\nuser may privately allocate.", "format": "int32", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Specifies the administrative name of the desktop. Each desktop\nin the site must have a unique name.", "nullable": true, "example": "Administrative name of the desktop" }, "PublishedName": { "title": "String", "type": "string", "description": "The name of the published desktop as seen by the user, and\nof assigned desktop(s) in the case where\nSharingKind\nis equal to Private.", "nullable": true, "example": "Published name of the desktop" }, "RestrictToTag": { "title": "String", "type": "string", "description": "Optional tag that may be used further to restrict which\ndesktops may be made accessible to a user.", "nullable": true, "example": "Name or Id of a tag" }, "SecureIcaRequired": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the desktop requires the SecureICA\nprotocol for desktop sessions.", "nullable": true }, "SessionReconnection": { "description": "Defines reconnection (roaming) behavior for sessions\nlaunched to the published desktop.", "nullable": true, "$ref": "#/components/schemas/SessionReconnection" }, "Tags": { "title": "String[]", "type": "array", "description": "The tags to associate with the desktop object ( only applies to broker entitlement policy).", "nullable": true, "example": [ "For example", " name of a tag" ], "items": { "title": "String", "type": "string" } } } }, "DesktopResponseModel": { "title": "DesktopResponseModel", "type": "object", "description": "Response object for a published desktop.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the desktop.", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED" }, "ColorDepth": { "description": "Color depth to use for desktop sessions to machines\nin the delivery group.", "$ref": "#/components/schemas/ColorDepth" }, "Description": { "title": "String", "type": "string", "description": "Optional description of the desktop.\nThe text may be visible to the end user, for example, as a\ntooltip associated with the desktop within receiver.", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the published desktop is enabled.\nA disabled desktop is ignored when determining which\ndesktops are available for a user." }, "ExcludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the ExcludedUsers filter is\nenabled. If the filter is disabled then any user entries in\nthe filter are ignored when determining which desktops are\navailable for a user." }, "ExcludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The excluded users filter of the desktop; that is,\nthe users and groups who are explicitly denied access to the\npublished desktop.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "IconId": { "title": "String", "type": "string", "description": "Id of the icon used to display the published\ndesktop to the user, and of assigned desktop(s) in the case\nwhere SharingKind\nis equal to Private.", "nullable": true }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery group's access\npolicy is implicitly granted an entitlement to the published\ndesktop." }, "IncludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The included users filter of the desktop; that is,\nthe users and groups who are explicitly granted access to the\npublished desktop.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "LeasingBehavior": { "description": "The desired connection leasing behavior applied to\ndesktop sessions.", "nullable": true, "$ref": "#/components/schemas/LeasingBehavior" }, "MaxDesktops": { "title": "Int32", "type": "integer", "description": "The number of machines from the delivery group which a\nuser may privately allocate.", "format": "int32", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "The administrative name of the desktop.", "nullable": true }, "PublishedName": { "title": "String", "type": "string", "description": "The name of the published desktop as seen by the user, and\nof assigned desktop(s) in the case where\nSharingKind\nis equal to Private.", "nullable": true }, "RestrictToTag": { "description": "Optional tag that may be used further to restrict which\ndesktops may be made accessible to a user.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "SecureIcaRequired": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the desktop requires the SecureICA\nprotocol for desktop sessions." }, "SessionReconnection": { "description": "Reconnection (roaming) behavior for sessions\nlaunched to the published desktop.", "nullable": true, "$ref": "#/components/schemas/SessionReconnection" }, "MachinesForAssignment": { "title": "Int32", "type": "integer", "description": "Indicates the number of machines which are available for assignment\nbased on this desktop configuration.", "format": "int32", "nullable": true }, "Tenants": { "title": "RefResponseModel[]", "type": "array", "description": "The tenant(s) that the desktop is assigned to. If `null`, the\ndesktop is not assigned to any tenants, and may be used by any\ntenant.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "Tags": { "title": "String[]", "type": "array", "description": "Tags associated with the desktop( only available for entitlement policy rules).", "nullable": true, "items": { "title": "String", "type": "string" } }, "DeliveryGroup": { "description": "Reference to the delivery group that this desktop belongs to.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "DeliveryGroupSessionSupport": { "description": "Session support type of the delivery group that this desktop belongs to.", "nullable": true, "$ref": "#/components/schemas/SessionSupport" } } }, "DesktopResponseModelCollection": { "title": "DesktopResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDesktopResponseModel" }, { "type": "object", "description": "Desktop response model collection", "additionalProperties": false } ] }, "DesktopUsageResponseModel": { "title": "DesktopUsageResponseModel", "type": "object", "description": "Desktop usage data.", "additionalProperties": false, "required": [ "Time", "FormattedTime", "Usage" ], "properties": { "Time": { "title": "String", "type": "string", "description": "Time when data point was collected.", "minLength": 1 }, "FormattedTime": { "title": "String", "type": "string", "description": "Formatted time when data point was collected.\nRFC 3339 compatible format.", "minLength": 1 }, "Usage": { "title": "Int32", "type": "integer", "description": "Specifies how many desktop are in use at the time the timestamp corresponds to.", "format": "int32" } } }, "DesktopUsageResponseModelCollection": { "title": "DesktopUsageResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfDesktopUsageResponseModel" }, { "type": "object", "description": "Desktop usage response model", "additionalProperties": false } ] }, "DetectOrphanedResourcesResponseModel": { "title": "DetectOrphanedResourcesResponseModel", "type": "object", "additionalProperties": false, "properties": { "Hypervisor": { "description": "The hypervisor upon which the detect was run. ", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "DetectScope": { "description": "The scope of detect report", "$ref": "#/components/schemas/DetectScope" }, "CreatedBy": { "title": "String", "type": "string", "description": "The owner of the detect report", "nullable": true }, "ReportTime": { "title": "String", "type": "string", "description": "The time of the detect report created", "nullable": true }, "DetectStart": { "title": "String", "type": "string", "description": "The time of detect start.", "nullable": true }, "DetectEnd": { "title": "String", "type": "string", "description": "The time of detect end.", "nullable": true }, "NumDetected": { "title": "Int32", "type": "integer", "description": "The number of orphaned resources detected. ", "format": "int32" }, "ErrorMsg": { "title": "String", "type": "string", "description": "Error message if orphaned resources detected failed. ", "nullable": true }, "IsFailed": { "title": "Boolean", "type": "boolean", "description": "If orphaned resources detected failed" }, "DetectResults": { "title": "DetectOrphanedResourcesResultModel[]", "type": "array", "description": "The detect results", "nullable": true, "items": { "$ref": "#/components/schemas/DetectOrphanedResourcesResultModel" } } } }, "DetectOrphanedResourcesResultModel": { "title": "DetectOrphanedResourcesResultModel", "type": "object", "description": "The result of running a detect. The result is composed of\na resource id, type and provisioning scheme id. ", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "The resource id. ", "nullable": true }, "Type": { "title": "String", "type": "string", "description": "The type of resource. ", "nullable": true }, "ProvisioningSchemeId": { "title": "String", "type": "string", "description": "The provisioning scheme Id. ", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of orphaned resource", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "DetectScope": { "title": "DetectScope", "type": "string", "description": "", "x-enumNames": [ "HostingConnection", "Unknown" ], "enum": [ "HostingConnection", "Unknown" ] }, "DeviceCollectionNameCheckRequestModel": { "title": "DeviceCollectionNameCheckRequestModel", "type": "object", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Device Collection name", "nullable": true }, "PvsSiteId": { "title": "String", "type": "string", "description": "PVS site id", "nullable": true } } }, "DeviceManagementType": { "title": "DeviceManagementType", "type": "string", "description": "Device management type for machines", "x-enumNames": [ "Unknown", "None", "Intune", "IntuneWithCitrixTags", "IntuneWithSCCM" ], "enum": [ "Unknown", "None", "Intune", "IntuneWithCitrixTags", "IntuneWithSCCM" ] }, "DiskPriceResponseModel": { "title": "DiskPriceResponseModel", "allOf": [ { "$ref": "#/components/schemas/DiskSettingRequestModel" }, { "type": "object", "description": "The response model for the pricing information of specific disk setting.", "additionalProperties": false, "properties": { "ResourcePrices": { "title": "ResourcePriceResponseModel[]", "type": "array", "description": "Gets or sets pricing information of billing components.", "nullable": true, "items": { "$ref": "#/components/schemas/ResourcePriceResponseModel" } } } } ] }, "DiskSettingRequestModel": { "title": "DiskSettingRequestModel", "type": "object", "description": "Request object allowing caller to specify a disk setting", "additionalProperties": false, "properties": { "StorageType": { "description": "The type of storage to use", "$ref": "#/components/schemas/DiskStorageType" }, "SizeInGB": { "title": "Int32", "type": "integer", "description": "The size of the disk in GB (gigabytes)", "format": "int32" }, "Location": { "title": "String", "type": "string", "description": "The location of the disk", "nullable": true } } }, "DiskStorageType": { "title": "DiskStorageType", "type": "string", "description": "The disk storage type", "x-enumNames": [ "Unknown", "Premium_LRS", "Standard_LRS", "StandardSSD_LRS", "Premium_ZRS", "StandardSSD_ZRS", "PremiumV2_LRS", "UltraSSD_LRS" ], "enum": [ "Unknown", "Premium_LRS", "Standard_LRS", "StandardSSD_LRS", "Premium_ZRS", "StandardSSD_ZRS", "PremiumV2_LRS", "UltraSSD_LRS" ] }, "DismissedResource": { "title": "DismissedResource", "type": "object", "description": "Dismissed resources for a recommendation.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Recommendation id.", "nullable": true }, "Targets": { "title": "DismissTargetModel[]", "type": "array", "description": "The resources the recommendation is dismissed for.", "nullable": true, "items": { "$ref": "#/components/schemas/DismissTargetModel" } } } }, "DismissTargetModel": { "title": "DismissTargetModel", "type": "object", "description": "Represents a dismiss target with Id and Name.", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Id of the dismiss target.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "The Name of the dismiss target.", "minLength": 1 }, "Note": { "title": "String", "type": "string", "description": "Optional note for the dismiss target. Maximum length is 256 characters.", "maxLength": 256, "nullable": true }, "Category": { "title": "String", "type": "string", "description": "The category of the dismiss target.", "nullable": true } } }, "DuplicateApplicationRequestModel": { "title": "DuplicateApplicationRequestModel", "type": "object", "description": "The Duplicate Application Request Model.", "additionalProperties": false, "properties": { "NewName": { "title": "String", "type": "string", "description": "Optional name for the duplicated application. If not specified, the system will\nchoose a new name automatically, based on the original application name.\nIf specified, must be unique within the site.", "maxLength": 64, "nullable": true, "example": "A new name for the application" }, "NewFolder": { "title": "String", "type": "string", "description": "Optional folder in which to create the duplicated application. If not specified,\nthe new application will be created in the same folder as the original.\nMay be specified as either Path or\nId. If specified as a path, and\nthe target does not exist, it will be automatically created.", "nullable": true, "example": "Path or Id of a folder" }, "CreateDisabled": { "title": "Boolean", "type": "boolean", "description": "Optional.\nIf not specified, or specified as `false`, the new application will have the\nsame visibility and enabled state as the original application. This may be\nundesirable; if the original application is visible, it means the new duplicate\nwill also be immediately visible to end users.\nSetting this to `true` causes the new duplicate to start out invisible and\ndisabled, allowing it to be further modified before making it visible to\nend users.", "default": false, "nullable": true } } }, "EditAdminFolderRequestModel": { "title": "EditAdminFolderRequestModel", "type": "object", "description": "Request object for editing an admin folder.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the admin folder.\n\nIf not set, will not be changed.\n\nThe name must be unique within the folder's parent folder.", "maxLength": 64, "nullable": true, "example": "Name of the admin folder" }, "Parent": { "title": "String", "type": "string", "description": "Parent folder.\n\nIf not set, will not be changed.\n\nCan be set to either Id or\nPath.\n\nTo move the application to the root folder, specify the empty string (\"\").\n\nIf specified as a path, and the path does not exist, it will be created.", "maxLength": 325, "nullable": true, "example": "Id or Path of the parent folder" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of Admin Folder. Set the value of the NameValueStringPairModel is null will not update MetadataMap\nSet the value of the NameValueStringPairModel empty will be remove this metadata.\nNot existing Name and Value NameValueStringPairModel object will be added.\nThe same Name but different value object will be updated.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "EditAdminRoleRequestModel": { "title": "EditAdminRoleRequestModel", "type": "object", "description": "Request object used when editing an admin role.", "additionalProperties": false, "properties": { "Description": { "title": "String", "type": "string", "description": "The description of the admin role.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "The name of the role. Name is globally unique.", "nullable": true }, "CanLaunchManage": { "title": "Boolean", "type": "boolean", "description": "Indicate that if the mangement page could be launch on xdconsole", "nullable": true }, "CanLaunchMonitor": { "title": "Boolean", "type": "boolean", "description": "Indicate that if the monitor page could be launch on xdconsole", "nullable": true }, "Permissions": { "title": "String[]", "type": "array", "description": "List of permissions granted by the role. At least one permission is\nrequired.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "EditAdminScopeRequestModel": { "title": "EditAdminScopeRequestModel", "type": "object", "description": "Request object used when editing an admin scope.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "The name of the scope. Name is globally unique.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The description of the admin scope.", "nullable": true }, "ScopedObjects": { "title": "ScopedObjectRequestModel[]", "type": "array", "description": "Scoped objects associated with the scope object.", "nullable": true, "items": { "$ref": "#/components/schemas/ScopedObjectRequestModel" } } } }, "EditAdvisorRecommendationRequestModel": { "title": "EditAdvisorRecommendationRequestModel", "type": "object", "description": "Represents a request model for advisor recommendations.", "additionalProperties": false, "properties": { "Dismiss": { "title": "Boolean", "type": "boolean", "description": "Dismiss the recommendation", "nullable": true }, "DismissTargets": { "title": "DismissTargetModel[]", "type": "array", "description": "Dismiss targets for this recommendation", "nullable": true, "items": { "$ref": "#/components/schemas/DismissTargetModel" } }, "UndismissTargets": { "title": "UndismissTargetModel[]", "type": "array", "description": "Undismiss targets for this recommendation", "nullable": true, "items": { "$ref": "#/components/schemas/UndismissTargetModel" } }, "UpdateDismissTargets": { "title": "UpdateDismissTargetModel[]", "type": "array", "description": "Update dismiss targets for this recommendation", "nullable": true, "items": { "$ref": "#/components/schemas/UpdateDismissTargetModel" } }, "AddedMetadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The added metadata", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "AddedVulnerabilityFixes": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The fixed vulnerabilities", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "EditAotSettingRequestModel": { "title": "EditAotSettingRequestModel", "type": "object", "additionalProperties": false, "properties": { "Server": { "title": "String", "type": "string", "description": "The log server name.", "nullable": true }, "Port": { "title": "Int32", "type": "integer", "description": "The log server port. ", "format": "int32", "nullable": true }, "EnabledOnDeliveryController": { "title": "Boolean", "type": "boolean", "description": "Enable AOT on delivery controller.", "nullable": true }, "EnabledOnAllDeliveryGroups": { "title": "Boolean", "type": "boolean", "description": "Enable AOT on all delivery groups.", "nullable": true }, "EnabledOnDeliveryGroups": { "title": "String[]", "type": "array", "description": "Enable AOT on the specified delivery groups.", "nullable": true, "items": { "title": "String", "type": "string" } }, "LogServerResourceLocationId": { "title": "String", "type": "string", "description": "The resource location where the log server locate.", "nullable": true }, "LogServerApiKey": { "title": "String", "type": "string", "description": "The API key to access the log server.", "nullable": true } } }, "EditAppLibPackageDiscoveryProfileRequestModel": { "title": "EditAppLibPackageDiscoveryProfileRequestModel", "type": "object", "description": "Request object for editing appLib package discovery profile.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "The name of the package discovery profile", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "DesktopGroupUid": { "title": "Int32", "type": "integer", "description": "The UID of the DesktopGroup from which the broker will select a VDA to run the discovery.", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0, "nullable": true }, "Path": { "title": "String", "type": "string", "description": "The root directory where the discovery will run", "maxLength": 250, "nullable": true }, "Recurse": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search the child directory tree.", "nullable": true }, "ManagementServer": { "title": "String", "type": "string", "description": "The url of the App-V Management server that packages will be discovered from.", "maxLength": 250, "nullable": true }, "PublishingServer": { "title": "String", "type": "string", "description": "The url of the App-V Publishing server that packages will be discovered from.", "maxLength": 250, "nullable": true }, "Username": { "title": "String", "type": "string", "description": "The username of the App-V Server Administrator.", "nullable": true }, "Password": { "title": "String", "type": "string", "description": "The password of the App-V Server Administrator.", "nullable": true }, "PasswordFormat": { "description": "Format of the Password. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "DiscoverAppV": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover App-V Packages.", "nullable": true }, "DiscoverMsix": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should Discover MSIX Packages.", "nullable": true }, "DiscoverAppAttach": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover AppAttach Packages.", "nullable": true }, "DiscoverFlexApp": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover FlexApp Packages.", "nullable": true }, "DiscoverElasticAppLayers": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover ElasticApp Layers packages.", "nullable": true }, "DiscoverCloudpaging": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to search should discover Cloudpaging Packages.", "nullable": true }, "AutomateDiscovery": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether the discovery should run automatically.", "nullable": true }, "AutoDiscoveryPeriod": { "description": "A value indicating what time period should use to trigger the discovery.", "nullable": true, "$ref": "#/components/schemas/AutoDiscoveryPeriod" }, "AutoDiscoveryCadence": { "title": "Int32", "type": "integer", "description": "A value indicating how often to trigger the discovery.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "CleanupAbsentPackages": { "title": "Boolean", "type": "boolean", "description": "A value indicating whether to clean up absent packages.", "nullable": true }, "CloudpagerConsoleUrl": { "title": "String", "type": "string", "description": "The URL of the Cloudpager Console.", "nullable": true }, "CloudpagerSubscriptionKey": { "title": "String", "type": "string", "description": "The Cloudpager Subscription Key.", "nullable": true }, "CloudpagerMsid": { "title": "String", "type": "string", "description": "The Cloudpager msid.", "nullable": true }, "IgnoreDowngrade": { "title": "Boolean", "type": "boolean", "description": "If ignore downgrade.", "nullable": true }, "InplaceUpgrade": { "title": "Boolean", "type": "boolean", "description": "If inplace upgrade.", "nullable": true } } }, "EditApplicationFolderRequestModel": { "title": "EditApplicationFolderRequestModel", "type": "object", "description": "Request object for editing an application folder.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the application folder.\n\nIf not set, will not be changed.\n\nThe name must be unique within the folder's parent folder.", "maxLength": 64, "nullable": true, "example": "Name of the application folder" }, "Parent": { "title": "String", "type": "string", "description": "Parent folder.\n\nIf not set, will not be changed.\n\nCan be set to either Id or\nPath.\n\nTo move the application to the root folder, specify the empty string (\"\").\n\nIf specified as a path, and the path does not exist, it will be created.", "maxLength": 325, "nullable": true, "example": "Id or Path of the parent folder" } } }, "EditApplicationGroupRequestModel": { "title": "EditApplicationGroupRequestModel", "type": "object", "description": "Request object for editing an application group.", "additionalProperties": false, "properties": { "AdminFolder": { "title": "String", "type": "string", "description": "The folder in which the application group resides.\nIf not specified, the value will not be changed.\nMay be specified as either the folder\nId or\nPath.\nIf specified as a path, and the path does not exist, it will be automatically\ncreated.", "nullable": true, "example": "Path or Id of the admin folder" }, "Name": { "title": "String", "type": "string", "description": "Name of the application group.\n\n\nIf not specified, will not be changed.", "maxLength": 64, "nullable": true, "example": "Name of the application group" }, "Description": { "title": "String", "type": "string", "description": "Description of the application group.\n\n\nIf not specified, will not be changed. To remove a previously set\ndescription, use the empty string (\"\").", "maxLength": 512, "nullable": true, "example": "Description of the application group" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the application group's applications can be launched by end users.\n\n\nIf not specified, will not be changed.", "nullable": true }, "RestrictToTag": { "title": "String", "type": "string", "description": "Optional tag that may be used further to restrict which machines may be used\nfor launching the application group's applications.\n\n\nA machine may be used by an application group if either the application group\nhas no tag restriction or the application group does have a tag restriction\nand the machine is tagged with the same tag.\n\n\nIf not specified, will not be changed. To remove a previously set tag\nrestriction, use the empty string (\"\").", "nullable": true, "example": "Name or Id of a tag" }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the application group should be a part\nof.\n\n\nIf not specified, will not be changed.\n\n\nThe \"All\" scope, and any tenant scopes, are implicit. To remove\nfrom all non-implicit scopes, specify an empty array ([]).\n\n\nSpecifying tenant scopes is equivalent to specifying the\n property and is subject to the same\nconstraints.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenants to associate with the application group.", "nullable": true, "example": [ "Name of a tenant" ], "items": { "title": "String", "type": "string" } }, "SessionSharingEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether the application group's applications can share sessions with\napplications that are not a member of this application group.\n\n\nIf not specified, will not be changed.", "nullable": true }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the filter is enabled. If the\nfilter is disabled then any user who satisfies the requirements of the\ndelivery groups' access polic(ies) is implicitly granted access to the\napplications within the application group.\n\n\nIf not specified, will not be changed.", "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the included users filter of the application group; that is, the\nusers and groups who are explicitly granted access to the applications in the\napplication group.\n\n\nIf not specified, will not be changed.\n\n\nIf specified, all desired users must be listed. To remove all users, specify\nan empty array ([]).", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } }, "DeliveryGroups": { "title": "PriorityRefRequestModel[]", "type": "array", "description": "List of delivery groups to associate with the application group.\n\n\nIf not specified, will not be changed.\n\n\nIf specified, all desired delivery groups must be listed. The application\ngroup must be associated with at least one delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/PriorityRefRequestModel" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the application group. When set the property value\nequal to null/empty means to remove this property.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "EditApplicationRequestModel": { "title": "EditApplicationRequestModel", "type": "object", "description": "Request object for editing an application.", "additionalProperties": false, "properties": { "ApplicationFolder": { "title": "String", "type": "string", "description": "The folder in which the application resides.\nIf not specified, the value will not be changed.\nMay be specified as either the folder\nId or\nPath.\nIf specified as a path, and the path does not exist, it will be automatically\ncreated.", "nullable": true, "example": "Path or Id of the application folder" }, "ApplicationGroups": { "title": "String[]", "type": "array", "description": "Specifies one or more application groups which the application will\nbe published to.\nIf not specified, will not be changed.\nIf specified, the entire list of application groups must be specified.\nTo disassociate the application from all application groups, specify\nan empty array ([]).", "nullable": true, "example": [ "Name of an application group" ], "items": { "title": "String", "type": "string" } }, "DeliveryGroups": { "title": "PriorityRefRequestModel[]", "type": "array", "description": "Specifies one or more delivery groups which the application will\nbe published to.\nIf not specified, will not be changed.\nIf specified, the entire list of delivery groups must be specified.\nTo disassociate the application from all delivery groups, specify\nan empty array ([]).", "nullable": true, "items": { "$ref": "#/components/schemas/PriorityRefRequestModel" } }, "BrowserName": { "title": "String", "type": "string", "description": "Internal name of the application.\nIf not specified, will not be changed.\nIf specified, must be unique within the site. For legacy reasons\nthe maximum length of the browser name cannot exceed 38 bytes when\nencoded using MBCS encoding.", "maxLength": 38, "nullable": true, "example": "Name of the application" }, "Categories": { "title": "String[]", "type": "array", "description": "Categories in which the application resides.\nIf not specified, the values will not be changed.\nIf specified, the entire list is required.", "nullable": true, "example": [ "Name of a category" ], "items": { "title": "String", "type": "string" } }, "ClientFolder": { "title": "String", "type": "string", "description": "The folder that the application belongs to as the user sees it.\nIf not specified, the value will not be changed.\nTo remove the client folder, specify the empty string (\"\").", "maxLength": 260, "nullable": true, "example": "Name of a client folder" }, "CpuPriorityLevel": { "description": "The CPU priority for the launched process.\nIf not specified, will not be changed.", "nullable": true, "$ref": "#/components/schemas/CpuPriorityLevel" }, "Description": { "title": "String", "type": "string", "description": "The description of the application.\nIf not specified, will not be changed.", "maxLength": 512, "nullable": true, "example": "Description of the application" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this application can be launched.\nIf not specified, will not be changed.", "nullable": true }, "DoNotEnumerate": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this application is enumerable", "nullable": true }, "HomeZone": { "title": "String", "type": "string", "description": "Home zone preference used when launching this\napplication.\nIf not specified, will not be changed.\nTo disassociate the application from a home zone, set this\nto the empty string (\"\").\nCannot be set for applications where ApplicationType\nis equal to InstalledOnClient or\nPublishedContent.\nCannot be set if HomeZoneMode is equal to\n\"HomeZoneMode.Ignore\".\nIf HomeZoneMode is equal to\n\"HomeZoneMode.Only\" or\n\"HomeZoneMode.Prefer\", the value must either have\nbeen previously set, or is required.\nMay be specified as either the Id or Name of the zone.", "nullable": true, "example": "For example, Primary" }, "HomeZoneMode": { "description": "The zone preference mode for application launches.\nIf not specified, will not be changed.", "nullable": true, "$ref": "#/components/schemas/HomeZoneMode" }, "Icon": { "title": "String", "type": "string", "description": "Icon used for the application.\nIf not specified, will not be changed.", "nullable": true, "example": "Data of the icon" }, "IconFromClient": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the icon is gotten from user's computer at run time.\nIf not specified, will not be changed.", "nullable": true }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedUsers filter is\nenabled. If the filter is disabled then any user who\nsatisfies the requirements of the delivery group's access\npolic(ies) is implicitly granted access to the application.\nIf not specified, will not be changed.", "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the included users filter of the application; that is,\nthe users and groups who are explicitly granted access to the\npublished application.\nIf not specified, will not be changed.\nIf specified, all users to be included must be specified.", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } }, "PackagedApplicationVisibility": { "description": "Specifies the resources (Workspace and/or Desktop session) where packaged application will be visible\nIf not specified, none of the packaged application visibility will be changed.", "nullable": true, "$ref": "#/components/schemas/PackagedApplicationVisibility" }, "InstalledAppProperties": { "description": "Properties of applications that are installed on servers\nor clients.\nIf not specified, none of the installed app properties will be changed.", "nullable": true, "$ref": "#/components/schemas/EditInstalledAppRequestModel" }, "PackagedAppProperties": { "description": "Properties of applications that are delivered via application packages.\nIf not specified, none of the Packaged App properties will be changed.\nIf specified, all PackagedApp properties must be specified.", "nullable": true, "$ref": "#/components/schemas/AppVAppRequestModel" }, "AppVAppProperties": { "description": "Properties of applications that are delivered via application packages (formerly App-V).\nIf not specified, none of the PackagedApp properties will be changed.\nIf specified, all PackagedApp properties must be specified.", "nullable": true, "$ref": "#/components/schemas/AppVAppRequestModel" }, "ContentLocation": { "title": "String", "type": "string", "description": "Location of published content.\nIf not specified, will not be changed.", "nullable": true, "example": "Url to the published content" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the application. When set the property value equal\nto null/empty means to remove this property.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "MaxPerUserInstances": { "title": "Int32", "type": "integer", "description": "Specifies the maximum allowed concurrently running instances of\nthe application that an individual user can have.\nIf not specified, will not be changed.", "format": "int32", "nullable": true }, "MaxTotalInstances": { "title": "Int32", "type": "integer", "description": "Specifies the maximum allowed total of concurrently running\ninstances of the application within the site.\nIf not specified, will not be changed.", "format": "int32", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the application. Only seen by administrators.\nIf not specified, will not be changed.\nIf specified, must be unique within the site.", "maxLength": 64, "nullable": true, "example": "For example, notepad++" }, "PublishedName": { "title": "String", "type": "string", "description": "The name seen by end users who have access to the application.\nIf not specified, will not be changed.", "nullable": true, "example": "For example, notepad++" }, "ShortcutAddedToDesktop": { "title": "Boolean", "type": "boolean", "description": "Specifies whether a shortcut to the application\nshould be placed on the user device.\nIf not specified, will not be changed.", "nullable": true }, "ShortcutAddedToStartMenu": { "title": "Boolean", "type": "boolean", "description": "Specifies whether a shortcut to the application\nshould be placed in the user's start menu on their user device.\nIf not specified, will not be changed.", "nullable": true }, "StartMenuFolder": { "title": "String", "type": "string", "description": "Specifies the name of the start menu folder that holds\nthe application shortcut (if any).\nIf not specified, will not be changed.\nTo clear a previously-set value, use the empty string (\"\").", "maxLength": 260, "nullable": true, "example": "For example, C:\\" }, "Visible": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this application is visible to users.\nIf not specified, will not be changed.", "nullable": true }, "WaitForPrinterCreation": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the session waits for the printers to\nbe created before allowing the user to interact with the session.\nIf not specified, will not be changed.", "nullable": true } } }, "EditBrokerHypervisorConnectionRequestModel": { "title": "EditBrokerHypervisorConnectionRequestModel", "type": "object", "description": "Edit broker hypervisor connection request model.", "additionalProperties": false, "properties": { "PreferredController": { "title": "String", "type": "string", "description": "The preferred controller.", "nullable": true } } }, "EditDeliveryGroupRequestModel": { "title": "EditDeliveryGroupRequestModel", "type": "object", "description": "Request object used when editing a delivery group.", "additionalProperties": false, "properties": { "AdminFolder": { "title": "String", "type": "string", "description": "The folder in which the delivery group resides.\nIf not specified, the value will not be changed.\nMay be specified as either the folder\nId or\nPath.\nIf specified as a path, and the path does not exist, it will be automatically\ncreated.", "nullable": true, "example": "Path or Id of the admin folder" }, "AssignMachinesToUsers": { "title": "AssignMachineToUserRequestModel[]", "type": "array", "description": "Machine assignments to users.", "nullable": true, "items": { "$ref": "#/components/schemas/AssignMachineToUserRequestModel" } }, "DeliveryType": { "description": "Type of resources that may be delivered from the delivery group.", "nullable": true, "$ref": "#/components/schemas/DeliveryKind" }, "Description": { "title": "String", "type": "string", "description": "A description for this delivery group useful for administrators\nof the site.", "nullable": true, "example": "Description of the delivery group" }, "Desktops": { "title": "DesktopRequestModel[]", "type": "array", "description": "List of desktop resources to publish on the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/DesktopRequestModel" } }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group should be in the enabled state; all\nresources published on disabled delivery groups do not appear\nto users.", "nullable": true }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Whether the delivery group should be created in maintenance mode;\na delivery group in maintenance mode will not allow users to\nconnect or reconnect to machines in the delivery group.", "nullable": true }, "MinimumFunctionalLevel": { "description": "The minimum functional level required for machines to work\nsuccessfully in the delivery group.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "Name": { "title": "String", "type": "string", "description": "The name of the new delivery group.", "nullable": true, "example": "Name of the new delivery group" }, "PublishedName": { "title": "String", "type": "string", "description": "The name of the desktop group as it is to appear to the user in StoreFront.", "nullable": true }, "RequireUserHomeZone": { "title": "Boolean", "type": "boolean", "description": "Whether to require the resources from this delivery group to\nlaunch within the user's home zone.", "nullable": true }, "ReuseMachinesWithoutShutdownInOutage": { "title": "Boolean", "type": "boolean", "description": "Whether machines will be reused without a shutdown in case of an outage.", "nullable": true }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the delivery group should be a part of.\nIf not specified, don't change.\nIf specified, *all* desired scopes must be listed. Any scope that the delivery\ngroup was part of previously, but which is not passed, will be removed.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenants to associate with the delivery group.", "nullable": true, "example": [ "Name or Id of a tenant" ], "items": { "title": "String", "type": "string" } }, "LoadBalanceType": { "description": "Specifies whether to use vertical scaling when\nfinding an RDS machine in the desktop group for a session launch.\nVertical scaling would saturate machines in the current pool\nrather than send sessions to the least loaded machines.\nIf not specified, don't change.\nWith the value None, the site-wide value will be inherited.\nA value of Horizontal indicates that horizontal scaling should be used.\nA value of Vertical indicates that vertical scaling should be used.", "nullable": true, "$ref": "#/components/schemas/LoadBalanceType" }, "AppProtectionKeyLoggingRequired": { "title": "Boolean", "type": "boolean", "description": "Specifies whether key logging app protection is required.", "nullable": true }, "AppProtectionScreenCaptureRequired": { "title": "Boolean", "type": "boolean", "description": "Specifies whether screen capture app protection is required.", "nullable": true }, "AppAccessPolicy": { "description": "Policy controlling access to all applications delivered from a\ndelivery group.", "nullable": true, "$ref": "#/components/schemas/AppAccessPolicyRequestModel" }, "AutomaticPowerOnForAssigned": { "title": "Boolean", "type": "boolean", "description": "Whether assigned (Private)\nmachines in the delivery group should be automatically\npowered-on at the start of peak time periods.", "nullable": true }, "AutomaticPowerOnForAssignedDuringPeak": { "title": "Boolean", "type": "boolean", "description": "Whether assigned (Private)\nmachines in the delivery group should be automatically\npowered-on throughout peak time periods.", "nullable": true }, "AutoScaleEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether auto-scale is enabled for the delivery group.", "nullable": true }, "RestrictAutoscaleTag": { "title": "String", "type": "string", "description": "Specifies the tag used to restrict autoscale.", "nullable": true }, "ColorDepth": { "description": "Specifies the color depth that the ICA session should use\nfor connections to machines in this group.", "nullable": true, "$ref": "#/components/schemas/ColorDepth" }, "ProductCode": { "title": "String", "type": "string", "description": "Specifies the product code of the delivery group.", "nullable": true }, "LicenseModel": { "description": "Specifies the license model of the delivery group.", "nullable": true, "$ref": "#/components/schemas/LicenseModel" }, "SecureIcaEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether connections to machines in the delivery group will\nuse SecureIca to encrypt the ICA protocol.", "nullable": true }, "DefaultDesktopIcon": { "title": "String", "type": "string", "description": "Default icon to use for desktops published from the delivery group.", "nullable": true, "example": "Data of the icon" }, "HdxSslEnabled": { "title": "Boolean", "type": "boolean", "description": "Whether connections to machines in the delivery group will\nuse SSL.", "nullable": true }, "LingerSettings": { "description": "Session linger settings for sessions launched on machines\nin the delivery group.", "nullable": true, "$ref": "#/components/schemas/FastApplicationSettingsRequestModel" }, "RestrictAutoscaleMinIdleUntaggedPercentDuringPeak": { "title": "Int32", "type": "integer", "description": "The percentage that the number of untagged single-session machines\nin an idle state, or for multi-session machines, the untagged available\nload capacity must fall below before Autoscale powers on and manages 'tagged'\nmachines, as per policy, in peak time. If the number of untagged machines in\nan idle state, or the untagged available load capacity goes above this threshold value,\nAutoscale will attempt to shut down 'tagged' machines.", "format": "int32", "maximum": 100.0, "minimum": -1.0, "nullable": true }, "RestrictAutoscaleMinIdleUntaggedPercentDuringOffPeak": { "title": "Int32", "type": "integer", "description": "The percentage that the number of untagged single-session machines in an idle state,\nor for multi-session machines, the untagged available load capacity must fall below\nbefore Autoscale powers on and manages 'tagged' machines, as per policy, in off-peak.\nIf the number of untagged machines in an idle state, or the untagged available load capacity\ngoes above this threshold value, Autoscale will attempt to shut down 'tagged' machines.", "format": "int32", "maximum": 100.0, "minimum": -1.0, "nullable": true }, "OffPeakBufferSizePercent": { "title": "Int32", "type": "integer", "description": "The percentage of machines in the delivery group that should be\nkept available in an idle state outside peak hours.", "format": "int32", "maximum": 100.0, "minimum": 0.0, "nullable": true }, "OffPeakDisconnectAction": { "description": "The action to be performed after a configurable period of a user\nsession disconnecting outside peak hours.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session disconnects outside peak hours.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "OffPeakExtendedDisconnectAction": { "description": "The action to be performed after a second configurable period of a\nuser session disconnecting outside peak hours.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakExtendedDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the second configured action should be\nperformed after a user session disconnects outside peak hours.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "OffPeakLogOffAction": { "description": "The action to be performed after a configurable period of a user\nsession ending outside peak hours.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "OffPeakLogOffTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session ends outside peak hours.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "PeakAutoscaleAssignedPowerOnIdleTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action is performed on an assigned machine previously\nstarted by autoscale that subsequently remains unused.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "PeakAutoscaleAssignedPowerOnIdleAction": { "description": "The action to be performed on an assigned machine started by Autoscale\nif that machine then remains unused for a defined period of time.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakBufferSizePercent": { "title": "Int32", "type": "integer", "description": "The percentage of machines in the delivery group that should be kept\navailable in an idle state in peak hours.", "format": "int32", "maximum": 100.0, "minimum": 0.0, "nullable": true }, "PeakDisconnectAction": { "description": "The action to be performed after a configurable period of a user\nsession disconnecting in peak hours.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session disconnects in peak hours.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "PeakExtendedDisconnectAction": { "description": "The action to be performed after a second configurable period of a\nuser session disconnecting in peak hours.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakExtendedDisconnectTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the second configured action should be\nperformed after a user session disconnects in peak hours.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LimitSecondsToForceLogOffUserDuringPeak": { "title": "Int32", "type": "integer", "description": "Represents the number of seconds that must elapsed before\nthe active sessions on the draining machines belonging to\nthe delivery group are logged off, during peak time.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LimitSecondsToForceLogOffUserDuringOffPeak": { "title": "Int32", "type": "integer", "description": "represents the number of seconds that must elapsed before\nthe active sessions on the draining machines belonging\nto the delivery group are logged off, during off-peak.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LogOffWarningMessage": { "title": "String", "type": "string", "description": "The warning message to display to users in active sessions prior to logging off users,\nwhether in peak time or off-peak.", "nullable": true }, "LogOffWarningTitle": { "title": "String", "type": "string", "description": "The title of the warning message dialog.", "nullable": true }, "PeakLogOffAction": { "description": "The action to be performed after a configurable period of a user\nsession ending in peak hours.", "nullable": true, "$ref": "#/components/schemas/SessionChangeHostingAction" }, "PeakLogOffTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The number of minutes before the configured action should be\nperformed after a user session ends in peak hours.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "DisconnectPeakIdleSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which an idle session\nbelonging to the delivery group is disconnected during peak time.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "DisconnectOffPeakIdleSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which an idle session\nbelonging to the delivery group is disconnected during off-peak time.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LogoffPeakDisconnectedSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which a disconnected session\nbelonging to the delivery group is terminated during peak time.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "LogoffOffPeakDisconnectedSessionAfterSeconds": { "title": "Int32", "type": "integer", "description": "Specifies the time in seconds after which a disconnected session\nbelonging to the delivery group is terminated during off-peak time.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "PowerTimeSchemes": { "title": "PowerTimeSchemeRequestModel[]", "type": "array", "description": "Power management time schemes. No two schemes may cover the same\nday of the week.", "nullable": true, "items": { "$ref": "#/components/schemas/PowerTimeSchemeRequestModel" } }, "PowerOffDelayMinutes": { "title": "Int32", "type": "integer", "description": "Delay before machines are powered off, when scaling down. Specified\nin minutes. Applies only to multi-session machines.", "format": "int32", "maximum": 60.0, "minimum": 0.0, "nullable": true }, "AutoscaleLogOffReminderEnabled": { "title": "Boolean", "type": "boolean", "description": "Boolean value indicating whether the warning messages should be\nsent on an interval to nudge a logoff\nshould be sent on an interval when autoscale is enabled.", "nullable": true }, "AutoscaleLogOffReminderIntervalSecondsOffPeak": { "title": "Int32", "type": "integer", "description": "Represents the time interval at which messages are sent to the user during off peak time\nwhen Autoscale is enabled.\nThis message will nudge users to log off instead of forcibly logging them off.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "AutoscaleLogOffReminderIntervalSecondsPeak": { "title": "Int32", "type": "integer", "description": "Represents the time interval at which messages are sent to the user during peak time\nwhen autoscale is enabled.\nThis message will nudge users to log off instead of forcibly logging them off.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "AutoscaleLogOffReminderMessage": { "title": "String", "type": "string", "description": "Notification message to display to users in active sessions\nbelonging to machines needed by Autoscale for shutdown.", "nullable": true }, "AutoscaleLogOffReminderTitle": { "title": "String", "type": "string", "description": "Notification message dialog title displayed\nwhen Autoscale issues a logoff reminder request.", "nullable": true }, "AutoscaleScaleDownActionDuringPeak": { "description": "Specifies the action to be used for Autoscale to scale down the number of machines in this desktop group during peak.\nPossible values are: Shutdown and Suspend. The default is Shutdown.", "nullable": true, "$ref": "#/components/schemas/AutoscaleScaleDownAction" }, "AutoscaleScaleDownActionDuringOffPeak": { "description": "Specifies the action to be used for Autoscale to scale down the number of machines in this desktop group during off-peak.\nPossible values are: Shutdown and Suspend. The default is Shutdown.", "nullable": true, "$ref": "#/components/schemas/AutoscaleScaleDownAction" }, "MachineCost": { "title": "Double", "type": "number", "description": "Indicates the estimated per-hour cost for machines in the delivery\ngroup, as set by the administrator.", "format": "double", "minimum": 0.0, "nullable": true }, "MachineLogOnType": { "description": "The login type for machines in this desktop group.", "nullable": true, "$ref": "#/components/schemas/MachineLogOnType" }, "PrelaunchSettings": { "description": "Prelaunch settings for users with resources published from\nthe delivery group.", "nullable": true, "$ref": "#/components/schemas/FastApplicationSettingsRequestModel" }, "ProtocolPriority": { "title": "ProtocolType[]", "type": "array", "description": "A list of protocols in the order in which they should be\nattempted for use during connection.", "nullable": true, "items": { "$ref": "#/components/schemas/ProtocolType" } }, "RebootSchedules": { "title": "RebootScheduleRequestModel[]", "type": "array", "description": "A list of reboot schedules.", "nullable": true, "items": { "$ref": "#/components/schemas/RebootScheduleRequestModel" } }, "SettlementPeriodBeforeAutoShutdownSeconds": { "title": "Int32", "type": "integer", "description": "Time after a session ends during which automatic shutdown\nrequests (for example, shutdown after use, idle pool\nmanagement) are deferred. Any outstanding shutdown request\ntakes effect after the settlement period expires. This is\ntypically used to configure time to allow logoff scripts\nto complete.", "format": "int32", "nullable": true }, "SettlementPeriodBeforeUseSeconds": { "title": "Int32", "type": "integer", "description": "Idle period before a machine can be selected to host a new\nsession after registration or the end of a previous\nsession. This is typically used to allow a machine to\nbecome idle following processing associated with start-up\nor logoff actions. A machine may still be selected during\nthe idle period if no other machine is available for\nimmediate use.", "format": "int32", "nullable": true }, "ShutdownDesktopsAfterUse": { "title": "Boolean", "type": "boolean", "description": "Whether machines in this delivery group should be\nautomatically shut down when each user session completes.", "nullable": true }, "SimpleAccessPolicy": { "description": "Simplified access policy for connections to the delivery group.\nIf you want to edit access policies through SimpleAccessPolicy, then AdvancedAccessPolicy\nin the request should be null.", "nullable": true, "$ref": "#/components/schemas/SimplifiedAccessPolicyRequestModel" }, "AdvancedAccessPolicy": { "title": "AdvancedAccessPolicyRequestModel[]", "type": "array", "description": "Advanced access policy for connections to the delivery group.\nIf you want to edit access policies through AdvancedAccessPolicy, then SimpleAccessPolicy\nin the request should be null.", "nullable": true, "items": { "$ref": "#/components/schemas/AdvancedAccessPolicyRequestModel" } }, "StoreFrontServersForHostedReceiver": { "title": "StoreFrontServerRequestModel[]", "type": "array", "description": "List of StoreFront server addresses to configure within hosted\nreceivers that are delivered from the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/StoreFrontServerRequestModel" } }, "TimeZone": { "title": "String", "type": "string", "description": "The time zone in which this delivery group's machines reside.", "nullable": true, "example": "For example, America/New_York" }, "TurnOnAddedMachines": { "title": "Boolean", "type": "boolean", "description": "Whether to attempt to power on machines when they are added\nto the delivery group.", "nullable": true }, "ZonePreferences": { "title": "ZonePreference[]", "type": "array", "description": "Ordered list of zone preferences to be applied when launching\nresources from this delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/ZonePreference" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of the delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "PolicySetGuid": { "title": "Guid", "type": "string", "description": "The GUID of the policy set assigned to this desktop group. Change if not null. Use Guid.Empty to clear\nthe value stored in the database. A non-null and non-empty GUID assigns the policy set to this desktop\ngroup.", "format": "guid", "nullable": true }, "RequiredSleepCapability": { "description": "The sleep capability of this desktop group. Change if not null.", "nullable": true, "$ref": "#/components/schemas/RequiredSleepCapability" } } }, "EditHypervisorAWCConnectionRequestModel": { "title": "EditHypervisorAWCConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the AWS APIs. Optional. If\nnot specified, will not be changed. If specified, the\nSecretKey must also be specified.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SecretKey": { "title": "String", "type": "string", "description": "The secret key used to authenticate with the AWS APIs. Optional.\nMust be specified in the format indicated by\nSecretKeyFormat.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SecretKeyFormat": { "description": "Format of the SecretKey. Only used if\nSecretKey is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "MaximumConcurrentProvisioningOperations": { "title": "Int32", "type": "integer", "description": "Maximum number of concurrent AWS provisioning operations.\nOptional. If not specified, will not be changed.", "format": "int32", "maximum": 1000.0, "minimum": 1.0, "nullable": true }, "Address": { "title": "String", "type": "string", "description": "Custom AWS Address. Only when the connection without the resourcePool can be updated.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "EditHypervisorAWSConnectionRequestModel": { "title": "EditHypervisorAWSConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the AWS APIs. Optional. If\nnot specified, will not be changed. If specified, the\nSecretKey must also be specified.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SecretKey": { "title": "String", "type": "string", "description": "The secret key used to authenticate with the AWS APIs. Optional.\nMust be specified in the format indicated by\nSecretKeyFormat.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SecretKeyFormat": { "description": "Format of the SecretKey. Only used if\nSecretKey is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "MaximumConcurrentProvisioningOperations": { "title": "Int32", "type": "integer", "description": "Maximum number of concurrent AWS provisioning operations.\nOptional. If not specified, will not be changed.", "format": "int32", "maximum": 1000.0, "minimum": 1.0, "nullable": true }, "Address": { "title": "String", "type": "string", "description": "Custom AWS Address. Only when the connection without the resourcePool can be updated.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "EditHypervisorAzureArcConnectionRequestModel": { "title": "EditHypervisorAzureArcConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure\nArc APIs. Optional. If not specified, will not be changed. If\nspecified, then ApplicationSecret must also be\nspecified.", "maxLength": 36, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$", "nullable": true }, "ApplicationSecret": { "title": "String", "type": "string", "description": "The Application Secret of the service principal used to access the\nAzure Arc APIs. Optional. If not specified, will not be changed. If\nspecified, must in the format indicated by\nApplicationSecretFormat.", "maxLength": 20480, "nullable": true }, "ApplicationSecretFormat": { "description": "Format of the ApplicationSecret. Only used if\nApplicationSecret is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "EditHypervisorAzureConnectionRequestModel": { "title": "EditHypervisorAzureConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure\nAPIs. Optional. If not specified, will not be changed. If\nspecified, then ApplicationSecret must also be\nspecified.", "maxLength": 36, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$", "nullable": true }, "ApplicationSecret": { "title": "String", "type": "string", "description": "The Application Secret of the service principal used to access the\nAzure APIs. Optional. If not specified, will not be changed. If\nspecified, must in the format indicated by\nApplicationSecretFormat.", "maxLength": 20480, "nullable": true }, "ApplicationSecretFormat": { "description": "Format of the ApplicationSecret. Only used if\nApplicationSecret is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "EditHypervisorConnectionRequestModel": { "title": "EditHypervisorConnectionRequestModel", "type": "object", "description": "Edit hypervisor connection details.", "additionalProperties": false, "required": [ "ConnectionType" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the hypervisor to create. Optional; if not specified, will\nnot be changed.", "maxLength": 64, "pattern": "(.*)*", "nullable": true, "example": "Name of the hypervisor" }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the hypervisor is in maintenance mode, which\ndisables all communication between XenApp & XenDesktop and the\nHypervisor. Optional; if not specified, will not be changed.", "nullable": true }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the newly created hypervisor will be a\npart of.\nIf not specified, will not be changed.\nThe \"All\" scope, and any tenant scopes, are implicit and cannot be\nremoved. To remove from all non-implicit scopes, specify an empty\narray ([]).\nSpecifying tenant scopes is equivalent to specifying the\nTenants property and is subject to the same\nconstraints.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenants to associate with the hypervisor.", "nullable": true, "example": [ "Name or id of a tenant" ], "items": { "title": "String", "type": "string" } }, "MaxAbsoluteActiveActions": { "title": "Int32", "type": "integer", "description": "Maximum number of actions that can execute in parallel on the\nhypervisor. Optional; if not specified, will not be changed.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "MaxAbsoluteNewActionsPerMinute": { "title": "Int32", "type": "integer", "description": "Maximum number of actions that can be started on the hypervisor\nper-minute. Optional; if not specified, will not be changed.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "MaxPowerActionsPercentageOfMachines": { "title": "Int32", "type": "integer", "description": "Maximum percentage of machines on the hypervisor which can have\ntheir power state changed simultaneously. Optional; if not\nspecified, will not be changed.", "format": "int32", "maximum": 100.0, "minimum": 0.0, "nullable": true }, "ConnectionOptions": { "title": "String", "type": "string", "description": "Connection options to use for the hypervisor. Optional; if not\nspecified, will not be changed. May be removed by specifying an\nempty string (`\"\"`).", "maxLength": 1000, "pattern": "((.|\\n)*)", "nullable": true, "example": "Connection options" }, "ConnectionType": { "description": "Type of hypervisor. Required, and must match the hypervisor's\npreviously-set type.", "$ref": "#/components/schemas/HypervisorConnectionType" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata for hypervisor connection. When set the property value equal to null/empty means to remove this property.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the AWS APIs. Optional. If\nnot specified, will not be changed. If specified, the\nSecretKey must also be specified.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SecretKey": { "title": "String", "type": "string", "description": "The secret key used to authenticate with the AWS APIs. Optional.\nMust be specified in the format indicated by\nSecretKeyFormat.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SecretKeyFormat": { "description": "Format of the SecretKey. Only used if\nSecretKey is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "MaximumConcurrentProvisioningOperations": { "title": "Int32", "type": "integer", "description": "Maximum number of concurrent AWS provisioning operations.\nOptional. If not specified, will not be changed.", "format": "int32", "maximum": 1000.0, "minimum": 1.0, "nullable": true }, "Address": { "title": "String", "type": "string", "description": "Custom AWS Address. Only when the connection without the resourcePool can be updated.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true }, "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure\nAPIs. Optional. If not specified, will not be changed. If\nspecified, then ApplicationSecret must also be\nspecified.", "maxLength": 36, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$", "nullable": true }, "ApplicationSecret": { "title": "String", "type": "string", "description": "The Application Secret of the service principal used to access the\nAzure APIs. Optional. If not specified, will not be changed. If\nspecified, must in the format indicated by\nApplicationSecretFormat.", "maxLength": 20480, "nullable": true }, "ApplicationSecretFormat": { "description": "Format of the ApplicationSecret. Only used if\nApplicationSecret is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Google Cloud APIs.\nOptional. If not specified, will not be changed. If specified,\nServiceAccountCredentials must also be specified.", "maxLength": 512, "pattern": "(.*)*", "nullable": true }, "ServiceAccountCredentials": { "title": "String", "type": "string", "description": "the JSON-encoded service account credentials used to access the\nGoogle Cloud APIs. Optional. If not specified, will not be\nchanged. If specified, must be in the format indicated by\nServiceAccountCredentialsFormat.", "maxLength": 2147483647, "pattern": "((.|\\n)*)", "nullable": true }, "ServiceAccountCredentialsFormat": { "description": "Format of the ServiceAccountCredentials. Only used if\nServiceAccountCredentials are specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "UserName": { "title": "String", "type": "string", "description": "Hypervisor username. Optional. If not specified, will not be\nchanged. If specified, Password must also be\nspecified.", "maxLength": 256, "pattern": "(.*)*", "nullable": true }, "Password": { "title": "String", "type": "string", "description": "Hypervisor password. Optional. If specified, must be in the format\nindicated by PasswordFormat.", "maxLength": 20480, "pattern": "(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*]).{8,}|^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|(.*)*", "nullable": true }, "PasswordFormat": { "description": "Format of the Password. Only used if\nPassword is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Addresses": { "title": "String[]", "type": "array", "description": "Hypervisor address(es). Optional. If not specified, will not be\nchanged.", "items": { "title": "String", "type": "string" } }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL certificate thumbprints to consider acceptable for this\nconnection. Optional. If not specified, will not be changed. To\nremove previously specified values, specify an empty array (`[]`).", "nullable": true, "items": { "title": "String", "type": "string" } }, "SccmWakeUpProxy": { "title": "Boolean", "type": "boolean", "description": "Specifies whether to use Microsoft System Center Configuration\nManager 2012 SP1 Wake-up Proxy for power management. Optional. If\nnot specified, will not be changed.", "nullable": true }, "WakeOnLanPackets": { "description": "Specifies the Wake on LAN packet transmission method to use for\npower management.", "nullable": true, "$ref": "#/components/schemas/WakeOnLanTransmission" }, "ServiceAccountCredential": { "title": "String", "type": "string", "description": "The private key string to access the Oracle Cloud Infrastructure APIs.\nRequired. Must be specified in the format\nindicated by ServiceAccountCredentialFormat.", "maxLength": 2147483647, "minLength": 1, "pattern": "((.|\\n)*)" }, "ServiceAccountCredentialFormat": { "description": "Format of the ServiceAccountCredential. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "ServiceAccountFingerprint": { "title": "String", "type": "string", "description": "The fingerprint of the public key associate with the ServiceAccountCredential.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" } } }, "EditHypervisorGCPConnectionRequestModel": { "title": "EditHypervisorGCPConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Google Cloud APIs.\nOptional. If not specified, will not be changed. If specified,\nServiceAccountCredentials must also be specified.", "maxLength": 512, "pattern": "(.*)*", "nullable": true }, "ServiceAccountCredentials": { "title": "String", "type": "string", "description": "the JSON-encoded service account credentials used to access the\nGoogle Cloud APIs. Optional. If not specified, will not be\nchanged. If specified, must be in the format indicated by\nServiceAccountCredentialsFormat.", "maxLength": 2147483647, "pattern": "((.|\\n)*)", "nullable": true }, "ServiceAccountCredentialsFormat": { "description": "Format of the ServiceAccountCredentials. Only used if\nServiceAccountCredentials are specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "EditHypervisorNutanixPCConnectionRequestModel": { "title": "EditHypervisorNutanixPCConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorTraditionalConnectionRequestModel" }, { "type": "object", "description": "Edit Hypervisor connection details for Nutanix PC hypervisors.", "additionalProperties": false } ] }, "EditHypervisorOciConnectionRequestModel": { "title": "EditHypervisorOciConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "ServiceAccountId", "ServiceAccountCredential", "ServiceAccountFingerprint" ], "properties": { "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Oracle Cloud Infrastructure APIs.\nRequired.", "maxLength": 128, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountCredential": { "title": "String", "type": "string", "description": "The private key string to access the Oracle Cloud Infrastructure APIs.\nRequired. Must be specified in the format\nindicated by ServiceAccountCredentialFormat.", "maxLength": 2147483647, "minLength": 1, "pattern": "((.|\\n)*)" }, "ServiceAccountCredentialFormat": { "description": "Format of the ServiceAccountCredential. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "ServiceAccountFingerprint": { "title": "String", "type": "string", "description": "The fingerprint of the public key associate with the ServiceAccountCredential.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" } } } ] }, "EditHypervisorOpenShiftConnectionRequestModel": { "title": "EditHypervisorOpenShiftConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "Addresses" ], "properties": { "UserName": { "title": "String", "type": "string", "description": "Hypervisor username. Optional. If not specified, will not be\nchanged. If specified, Password must also be\nspecified.", "maxLength": 256, "pattern": "(.*)*", "nullable": true }, "Password": { "title": "String", "type": "string", "description": "Hypervisor password. Optional. If specified, must be in the format\nindicated by PasswordFormat.", "maxLength": 20480, "pattern": "(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*]).{8,}|^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|(.*)*", "nullable": true }, "PasswordFormat": { "description": "Format of the Password. Only used if\nPassword is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Addresses": { "title": "String[]", "type": "array", "description": "Hypervisor address. Optional. If not specified, will not be\nchanged.", "items": { "title": "String", "type": "string" } }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL certificate thumbprints to consider acceptable for this\nconnection. Optional. If not specified, will not be changed. To\nremove previously specified values, specify an empty array (`[]`).", "nullable": true, "items": { "title": "String", "type": "string" } }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "EditHypervisorOracleC3ConnectionRequestModel": { "title": "EditHypervisorOracleC3ConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "ServiceAccountId", "ServiceAccountCredential", "ServiceAccountFingerprint" ], "properties": { "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Oracle Compute Cloud@Customer APIs.\nRequired.", "maxLength": 128, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountCredential": { "title": "String", "type": "string", "description": "The private key string to access the Oracle Compute Cloud@Customer APIs.\nRequired. Must be specified in the format\nindicated by ServiceAccountCredentialFormat.", "maxLength": 2147483647, "minLength": 1, "pattern": "((.|\\n)*)" }, "ServiceAccountCredentialFormat": { "description": "Format of the ServiceAccountCredential. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "ServiceAccountFingerprint": { "title": "String", "type": "string", "description": "The fingerprint of the public key associate with the ServiceAccountCredential.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL certificate thumbprints to consider acceptable for this\nconnection. Optional. If not specified, will not be changed. To\nremove previously specified values, specify an empty array (`[]`).", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "EditHypervisorResourcePoolAWSOrGcpRequestModel": { "title": "EditHypervisorResourcePoolAWSOrGcpRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorResourcePoolRequestModel" }, { "type": "object", "description": "Edit an AWS or GCP hypervisor resource pool. Note that in previous versions of\nthe API, a \"resource pool\" was known as a \"hosting unit\".", "additionalProperties": false, "properties": { "Networks": { "title": "String[]", "type": "array", "description": "Path to the network resource(s) that are available for provisioning\noperations in this resource pool. At least one is required.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "EditHypervisorResourcePoolAzureRequestModel": { "title": "EditHypervisorResourcePoolAzureRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorResourcePoolRequestModel" }, { "type": "object", "description": "Edit an Azure hypervisor resource pool. Note that in previous versions of\nthe API, a \"resource pool\" was known as a \"hosting unit\".", "additionalProperties": false, "properties": { "Subnets": { "title": "String[]", "type": "array", "description": "Path to the subnet(s) that are available for provisioning operations\nin this resource pool. At least one is required.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "EditHypervisorResourcePoolNutanixPCRequestModel": { "title": "EditHypervisorResourcePoolNutanixPCRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorResourcePoolRequestModel" }, { "type": "object", "description": "Edit a hypervisor resource pool. Note that in previous versions of\nthe API, a \"resource pool\" was known as a \"hosting unit\".", "additionalProperties": false } ] }, "EditHypervisorResourcePoolRequestModel": { "title": "EditHypervisorResourcePoolRequestModel", "type": "object", "description": "Edit a hypervisor resource pool. Note that in previous versions of the\nAPI, a \"resource pool\" was known as a \"hosting unit\".", "additionalProperties": false, "required": [ "ConnectionType" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the resource pool. Optional. If not specified, will not be changed.", "maxLength": 64, "pattern": "(.*)*", "nullable": true, "example": "Name of the resource pool" }, "ConnectionType": { "description": "Type of hypervisor. Required, and must match the type of hypervisor\nspecified for the hypervisor connection that the resource pool is\nattached to.", "$ref": "#/components/schemas/HypervisorConnectionType" }, "VmTagging": { "title": "Boolean", "type": "boolean", "description": "Indicates whether VMs created by Virtual Apps & Desktops\nprovisioning operations should be tagged. Tagged VMs are filtered\nout of queries by default.", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata for hypervisor resource pool. When set the property value equal to null/empty means to remove this property.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Storage": { "title": "HypervisorResourcePoolStorageRequestModel[]", "type": "array", "description": "Path to the storage resource(s) that are available for provisioning\noperations in this resource pool.\nOptional; if not specified, will not be changed. If any storage is\nspecified, all desired storage must be listed. Any storage that was\npreviously used for the resource pool, but not listed during an edit\noperation, will be removed.\nNote that removing storage from the resource pool will permanently\ndisable the ability to update or rollback machines that are\nprovisioned using that storage. Therefore, removal of storage\nshould _only_ be done when the storage is terminally broken or is\nbeing replaced.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourcePoolStorageRequestModel" } }, "TemporaryStorage": { "title": "HypervisorResourcePoolStorageRequestModel[]", "type": "array", "description": "Path to the storage resource(s) that are used for temporary\noperations in this resource pool.\nOptional; if not specified, will not be changed. If any storage is\nspecified, all desired storage must be listed. Any storage that was\npreviously used for the resource pool, but not listed during an edit\noperation, will be removed.\nNote that removing storage from the resource pool will permanently\ndisable the ability to update or rollback machines that are\nprovisioned using that storage. Therefore, removal of storage\nshould _only_ be done when the storage is terminally broken or is\nbeing replaced.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourcePoolStorageRequestModel" } }, "PersonalvDiskStorage": { "title": "HypervisorResourcePoolStorageRequestModel[]", "type": "array", "description": "Path to the personal virtual disk storage resource(s).\nOptional; if not specified, will not be changed. If any storage is\nspecified, all desired storage must be listed. Any storage that was\npreviously used for the resource pool, but not listed during an edit\noperation, will be removed.\nNote that removing storage from the resource pool will permanently\ndisable the ability to update or rollback machines that are\nprovisioned using that storage. Therefore, removal of storage\nshould _only_ be done when the storage is terminally broken or is\nbeing replaced.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourcePoolStorageRequestModel" } }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true }, "UseLocalStorageCaching": { "title": "Boolean", "type": "boolean", "description": "Indicates whether local storage on the hypervisor will be used for\ncaching purposes. Not all hypervisor types support this. Defaults\nto `false`.", "nullable": true }, "Networks": { "title": "String[]", "type": "array", "description": "Path to the network resource(s) that are available for provisioning\noperations in this resource pool. At least one is required.", "nullable": true, "items": { "title": "String", "type": "string" } }, "StorageBalanceType": { "description": "Storage Balance Type. Only used for hypervisors of type\nXenServer.\nSCVMM.\nVCenter.", "nullable": true, "$ref": "#/components/schemas/StorageBalanceType" }, "Subnets": { "title": "String[]", "type": "array", "description": "Path to the subnet(s) that are available for provisioning operations\nin this resource pool. At least one is required.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "EditHypervisorResourcePoolTraditionalRequestModel": { "title": "EditHypervisorResourcePoolTraditionalRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorResourcePoolRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "Storage": { "title": "HypervisorResourcePoolStorageRequestModel[]", "type": "array", "description": "Path to the storage resource(s) that are available for provisioning\noperations in this resource pool.\nOptional; if not specified, will not be changed. If any storage is\nspecified, all desired storage must be listed. Any storage that was\npreviously used for the resource pool, but not listed during an edit\noperation, will be removed.\nNote that removing storage from the resource pool will permanently\ndisable the ability to update or rollback machines that are\nprovisioned using that storage. Therefore, removal of storage\nshould _only_ be done when the storage is terminally broken or is\nbeing replaced.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourcePoolStorageRequestModel" } }, "TemporaryStorage": { "title": "HypervisorResourcePoolStorageRequestModel[]", "type": "array", "description": "Path to the storage resource(s) that are used for temporary\noperations in this resource pool.\nOptional; if not specified, will not be changed. If any storage is\nspecified, all desired storage must be listed. Any storage that was\npreviously used for the resource pool, but not listed during an edit\noperation, will be removed.\nNote that removing storage from the resource pool will permanently\ndisable the ability to update or rollback machines that are\nprovisioned using that storage. Therefore, removal of storage\nshould _only_ be done when the storage is terminally broken or is\nbeing replaced.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourcePoolStorageRequestModel" } }, "PersonalvDiskStorage": { "title": "HypervisorResourcePoolStorageRequestModel[]", "type": "array", "description": "Path to the personal virtual disk storage resource(s).\nOptional; if not specified, will not be changed. If any storage is\nspecified, all desired storage must be listed. Any storage that was\npreviously used for the resource pool, but not listed during an edit\noperation, will be removed.\nNote that removing storage from the resource pool will permanently\ndisable the ability to update or rollback machines that are\nprovisioned using that storage. Therefore, removal of storage\nshould _only_ be done when the storage is terminally broken or is\nbeing replaced.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourcePoolStorageRequestModel" } }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true }, "UseLocalStorageCaching": { "title": "Boolean", "type": "boolean", "description": "Indicates whether local storage on the hypervisor will be used for\ncaching purposes. Not all hypervisor types support this. Defaults\nto `false`.", "nullable": true }, "Networks": { "title": "String[]", "type": "array", "description": "Path to the network resource(s) that are available for provisioning\noperations in this resource pool. At least one is required.", "nullable": true, "items": { "title": "String", "type": "string" } }, "StorageBalanceType": { "description": "Storage Balance Type. Only used for hypervisors of type\nXenServer.\nSCVMM.\nVCenter.", "nullable": true, "$ref": "#/components/schemas/StorageBalanceType" } } } ] }, "EditHypervisorTraditionalConnectionRequestModel": { "title": "EditHypervisorTraditionalConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "Addresses" ], "properties": { "UserName": { "title": "String", "type": "string", "description": "Hypervisor username. Optional. If not specified, will not be\nchanged. If specified, Password must also be\nspecified.", "maxLength": 256, "pattern": "(.*)*", "nullable": true }, "Password": { "title": "String", "type": "string", "description": "Hypervisor password. Optional. If specified, must be in the format\nindicated by PasswordFormat.", "maxLength": 20480, "pattern": "(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*]).{8,}|^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|(.*)*", "nullable": true }, "PasswordFormat": { "description": "Format of the Password. Only used if\nPassword is specified. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Addresses": { "title": "String[]", "type": "array", "description": "Hypervisor address(es). Optional. If not specified, will not be\nchanged.", "items": { "title": "String", "type": "string" } }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL certificate thumbprints to consider acceptable for this\nconnection. Optional. If not specified, will not be changed. To\nremove previously specified values, specify an empty array (`[]`).", "nullable": true, "items": { "title": "String", "type": "string" } }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "EditHypervisorWOLConnectionRequestModel": { "title": "EditHypervisorWOLConnectionRequestModel", "allOf": [ { "$ref": "#/components/schemas/EditHypervisorTraditionalConnectionRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "SccmWakeUpProxy": { "title": "Boolean", "type": "boolean", "description": "Specifies whether to use Microsoft System Center Configuration\nManager 2012 SP1 Wake-up Proxy for power management. Optional. If\nnot specified, will not be changed.", "nullable": true }, "WakeOnLanPackets": { "description": "Specifies the Wake on LAN packet transmission method to use for\npower management.", "nullable": true, "$ref": "#/components/schemas/WakeOnLanTransmission" } } } ] }, "EditInstalledAppRequestModel": { "title": "EditInstalledAppRequestModel", "type": "object", "description": "Response object for installed application properties.", "additionalProperties": false, "properties": { "CommandLineArguments": { "title": "String", "type": "string", "description": "The command-line arguments to use when launching the\nexecutable. Environment variables can be used.\nIf not specified, the value will not be changed.", "maxLength": 8191, "nullable": true, "example": "For example, --debug" }, "CommandLineExecutable": { "title": "String", "type": "string", "description": "The name of the executable file to launch. The full\npath need not be provided if it's already in the path.\nEnvironment variables can also be used.\nIf not specified, the value will not be changed.", "maxLength": 8191, "nullable": true, "example": "For example, C:\\test\\test.exe" }, "WorkingDirectory": { "title": "String", "type": "string", "description": "The working directory which the executable is launched\nfrom. Environment variables can be used. \nIf not specified, the value will not be changed.", "maxLength": 260, "nullable": true, "example": "For example, C:\\test" } } }, "EditLicenseProductEditionRequestModel": { "title": "EditLicenseProductEditionRequestModel", "type": "object", "description": "Request model to edit license product edition", "additionalProperties": false, "properties": { "UseLicenseActivationService": { "title": "Boolean", "type": "boolean", "description": "Use License Activation Service and should be used exclusively", "nullable": true }, "LicenseProduct": { "description": "The product code.", "$ref": "#/components/schemas/LicenseProduct" }, "ProductEdition": { "description": "The product edition.", "$ref": "#/components/schemas/ProductEdition" }, "LicenseModel": { "description": "The license model.", "$ref": "#/components/schemas/LicenseModel" } } }, "EditLicenseServerRequestModel": { "title": "EditLicenseServerRequestModel", "type": "object", "description": "Request object for changing license server", "additionalProperties": false, "required": [ "LicenseServer" ], "properties": { "LicenseServer": { "title": "String", "type": "string", "description": "License server address", "minLength": 1 }, "Thumbprint": { "title": "String", "type": "string", "description": "The certificate thumbprint of the license server", "nullable": true } } }, "EditOperationRequestModel": { "title": "EditOperationRequestModel", "type": "object", "description": "Model for editing a high level log operation.", "additionalProperties": false, "properties": { "Labels": { "title": "String[]", "type": "array", "description": "The new labels of the operation.\nNOTE: For each label, it is case-insensitive with a max length of 60 and any leading or trailing whitespaces will be trimmed.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "EditSiteSettingsRequestModel": { "title": "EditSiteSettingsRequestModel", "type": "object", "additionalProperties": false, "properties": { "UseVerticalScalingForRdsLaunches": { "title": "Boolean", "type": "boolean", "description": "Determines whether to use vertical scaling when considering RDS machines for launches.\nVertical scaling would saturate machines in the current pool rather than\nsend sessions to the least loaded machines.\nThis would be a trade in performance vs. cost, where vertical scaling would be less costly.", "nullable": true }, "DnsResolutionEnabled": { "title": "Boolean", "type": "boolean", "description": "Changes whether ICA files returned by a broker service to\na user device contain the numeric IP address or the DNS name\nof the desktop machine to which a session should be established.", "nullable": true }, "TrustRequestsSentToTheXmlServicePortEnabled": { "title": "Boolean", "type": "boolean", "description": "Changes whether the XML Service (as used by Storefront)\nimplicitly trusts the originator of requests it receives,\nor whether it fully authenticates them.", "nullable": true }, "WebUiPolicySetEnabled": { "title": "Boolean", "type": "boolean", "description": "Determine whether the policy set in web UI is enabled or not", "nullable": true }, "ConsoleInactivityTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The max number of minutes that console can be inactive.", "format": "int32", "maximum": 10000.0, "minimum": 0.0, "nullable": true }, "SupportedAuthenticators": { "description": "Applicable only for On-Premise.\nDetermine the supported authentication methods.", "nullable": true, "$ref": "#/components/schemas/Authenticator" }, "ShowSecurityBannerOnLoginPage": { "title": "Boolean", "type": "boolean", "description": "Applicable only for On-Premise.\nIndicate whether to display security banner on the login page.", "nullable": true }, "SecurityBannerOnLoginPage": { "title": "String", "type": "string", "description": "Applicable only for On-Premise.\nThe custom security banner on the login page, max length is 5000.", "nullable": true }, "ShowConnectedControllerOnLoginPage": { "title": "Boolean", "type": "boolean", "description": "Applicable only for On-Premise.\nIndicate whether to display the DDC used for the current Studio session on the login page.", "nullable": true }, "AllowedCorsOriginsForIwa": { "title": "String[]", "type": "array", "description": "Applicable only for On-Premise.\nList of origins allowed to make cross-origin requests for Integrated Windows Authentication.", "nullable": true, "items": { "title": "String", "type": "string" } }, "MultiSites": { "title": "MultiSiteModel[]", "type": "array", "description": "Applicable only for On-Premise.\nMultiple sites configuration.", "nullable": true, "items": { "$ref": "#/components/schemas/MultiSiteModel" } }, "DefaultDomain": { "title": "String", "type": "string", "description": "The default domain to be used in the login page.", "nullable": true }, "MultiTenantServicesAccess": { "description": "Cloud Services access to DaaS.", "nullable": true, "$ref": "#/components/schemas/MultiTenantServicesAccessModel" }, "AotSetting": { "description": " ", "nullable": true, "$ref": "#/components/schemas/EditAotSettingRequestModel" }, "EntraIdSetting": { "description": "Entra ID settings.", "nullable": true, "$ref": "#/components/schemas/EntraIdSettingModel" } } }, "EditUserZonePreferenceRequestModel": { "title": "EditUserZonePreferenceRequestModel", "type": "object", "description": "Request model for updating user zone preference.", "additionalProperties": false, "required": [ "ZoneId" ], "properties": { "ZoneId": { "title": "String", "type": "string", "description": "The id of the new zone.", "minLength": 1, "example": "For example, c7b0d0a7-b53b-42e1-8f69-accebb407e2b" } } }, "EditZoneRequestModel": { "title": "EditZoneRequestModel", "type": "object", "description": "Model for editing zone.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "The new name of the zone. Zone names are unique across the site.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The new description of the zone.", "nullable": true }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the zone should be a part of.\nIf not specified, don't change.\nIf specified, *all* desired scopes must be listed. Any scope that the delivery\ngroup was part of previously, but which is not passed, will be removed.", "nullable": true, "items": { "title": "String", "type": "string" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The new metadata of the zone.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "EmbeddedAttribute": {}, "EnrollMachineMetaDataModel": { "title": "EnrollMachineMetaDataModel", "type": "object", "description": "Model for enrolling machine meta data", "additionalProperties": false, "properties": { "HostedMachineId": { "title": "String", "type": "string", "description": "Presented if such an id could be found from the enrolled vda machine locally", "nullable": true }, "MacAddresses": { "title": "String[]", "type": "array", "description": "The enrolled machine's MAC addresses ", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "EnrollMachineRequestModel": { "title": "EnrollMachineRequestModel", "type": "object", "description": "Model for Enrolling the websocket machine", "additionalProperties": false, "required": [ "VdaInstanceId", "VdaInstanceName", "ServicePublicKey", "MachineSid" ], "properties": { "VdaInstanceId": { "title": "String", "type": "string", "description": "The id for the vda's key pair registered with the MFA trust service.", "minLength": 1 }, "VdaInstanceName": { "title": "String", "type": "string", "description": "The instance name for the key. it is also used as the machine's name for non-domain joined vda.", "minLength": 1 }, "ServicePublicKey": { "title": "String", "type": "string", "description": "The vda's public service key to be registered with FMA Trust Service.", "minLength": 1 }, "MachineSid": { "title": "String", "type": "string", "description": "Real sid of AD machine for domain joined; or virtual sid if non-domain joined\nthis parameter will be used to create machine", "minLength": 1 }, "MachineMetadata": { "description": "Addition machine data for mapping machine to machine's \"hosted machine id\" which is needed for power management by its hypervisor", "nullable": true, "$ref": "#/components/schemas/EnrollMachineMetaDataModel" } } }, "EnrollMachineResponseModel": { "title": "EnrollMachineResponseModel", "type": "object", "description": "Model for Enrolling the websocket machine", "additionalProperties": false, "properties": { "SiteAddress": { "title": "String", "type": "string", "description": "The site address.", "nullable": true }, "VirtualSiteId": { "title": "String", "type": "string", "description": "The virtual site id", "nullable": true }, "ListOfDDCs": { "title": "String[]", "type": "array", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "EnrollmentRequestModel": { "title": "EnrollmentRequestModel", "type": "object", "description": "Request object for Enrollments.", "additionalProperties": false, "required": [ "TokenName", "CatalogId" ], "properties": { "TokenName": { "title": "String", "type": "string", "description": "Gets or sets the name used to more easily identify this VDA enrollment token.", "minLength": 1 }, "IssuedToUser": { "title": "String", "type": "string", "description": "Gets or sets the name of the user to whom this VDA enrollment token meta data object is issued.", "nullable": true }, "ExpirationDate": { "title": "DateTime", "type": "string", "description": "Gets or sets the date this VDA enrollment token expires.", "format": "date-time", "nullable": true }, "NotValidBeforeDate": { "title": "DateTime", "type": "string", "description": "Gets or sets the UTC date before which this VDA enrollment token will not be valid.", "format": "date-time", "nullable": true }, "NumMachinesAllowed": { "title": "Int32", "type": "integer", "description": "Gets or sets the number of machines this VDA enrollment token allows to be added to the catalog.", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 }, "CatalogId": { "title": "String", "type": "string", "description": "Gets or sets the Catalog Id that this VDA enrollment token allows machines to be added to.", "minLength": 1 }, "HostConnectionId": { "title": "Guid", "type": "string", "description": "Gets or sets the HostConnectionId which will be used to determine how to handle power management.", "format": "guid", "nullable": true } } }, "EnrollmentResponseModel": { "title": "EnrollmentResponseModel", "type": "object", "description": "Response object for a enrollment.", "additionalProperties": false, "properties": { "Id": { "title": "Guid", "type": "string", "description": "Gets or sets the unique id of this VDA enrollment token meta data object.", "format": "guid" }, "TokenName": { "title": "String", "type": "string", "description": "Gets or sets the name used to more easily identify this VDA enrollment token.", "nullable": true }, "IssuerId": { "title": "String", "type": "string", "description": "Gets or sets the unique id of the admin who created this VDA enrollment token meta data object.", "nullable": true }, "IssuedToUser": { "title": "String", "type": "string", "description": "Gets or sets the name of the user to whom this VDA enrollment token meta data object is issued.", "nullable": true }, "DateIssued": { "title": "String", "type": "string", "description": "Gets or sets the date this VDA enrollment token meta data object was created.", "nullable": true }, "ExpirationDate": { "title": "String", "type": "string", "description": "Gets or sets the date this VDA enrollment token expires.", "nullable": true }, "NotValidBeforeDate": { "title": "String", "type": "string", "description": "Gets or sets the UTC date before which this VDA enrollment token will not be valid.", "nullable": true }, "NumMachinesAllowed": { "title": "Int32", "type": "integer", "description": "Gets or sets the number of machines this VDA enrollment token allows to be added to the catalog.", "format": "int32" }, "CatalogId": { "title": "String", "type": "string", "description": "Gets or sets the Catalog Id that this VDA enrollment token allows machines to be added to.", "nullable": true }, "IsRevoked": { "title": "Boolean", "type": "boolean", "description": "Gets or sets the flag indicating that this VDA enrollment token has been revoked." }, "LastUsed": { "title": "String", "type": "string", "description": "Gets or sets the date this VDA enrollment token was last used to add a machine to a catalog.", "nullable": true }, "NumTimesUsed": { "title": "Int32", "type": "integer", "description": "Gets or sets the number of times this token was used to attempt to add machines to the specified catalog.", "format": "int32" }, "Token": { "title": "String", "type": "string", "description": "The JWT VDA enrollment token created from the data properties.", "nullable": true }, "HostConnectionId": { "title": "Guid", "type": "string", "description": "Gets or sets the HostConnectionId which will be used to determine how to handle power management.", "format": "guid", "nullable": true } } }, "EnrollmentResponseModelCollection": { "title": "EnrollmentResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfEnrollmentResponseModel" }, { "type": "object", "description": "Enrollment response collection", "additionalProperties": false } ] }, "EntraIdSettingModel": { "title": "EntraIdSettingModel", "type": "object", "description": "Represents the model for editing Entra ID settings.", "additionalProperties": false, "properties": { "AzureGlobalCloudId": { "title": "String", "type": "string", "description": "Gets or sets the Azure Global Cloud Identifier.", "nullable": true }, "AzureSSOnAuthorizeUrl": { "title": "String", "type": "string", "description": "Gets or sets the Azure Single Sign-On (SSO) Authorization URL.", "nullable": true }, "AzureSSOnClientId": { "title": "String", "type": "string", "description": "Gets or sets the Azure Single Sign-On (SSO) Client Identifier.", "nullable": true }, "AzureSSOnRedirectUrl": { "title": "String", "type": "string", "description": "Gets or sets the Azure Single Sign-On (SSO) Redirect URL.", "nullable": true }, "AzureSSOnResourceAppId": { "title": "String", "type": "string", "description": "Gets or sets the Azure Single Sign-On (SSO) Resource Application Identifier.", "nullable": true } } }, "EnumerationMember": { "title": "EnumerationMember", "type": "object", "description": "Member of enum type.", "additionalProperties": false, "properties": { "name": { "title": "String", "type": "string", "description": "Member name.", "nullable": true }, "value": { "title": "Int32", "type": "integer", "description": "Integer value of the member.", "format": "int32" }, "displayName": { "title": "String", "type": "string", "description": "localized name of the member.", "nullable": true } } }, "EnumerationMemberContract": { "title": "EnumerationMemberContract", "type": "object", "description": "Member of enum type.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Member name", "nullable": true }, "Value": { "title": "Int32", "type": "integer", "description": "Integer value of the member.", "format": "int32" }, "DisplayName": { "title": "String", "type": "string", "description": "Translated names of the member.", "nullable": true } } }, "EnumerationType": { "title": "EnumerationType", "type": "object", "description": "Enumeration type", "additionalProperties": false, "properties": { "typeName": { "title": "String", "type": "string", "description": "Name of the type.", "nullable": true }, "members": { "title": "EnumerationMember[]", "type": "array", "description": "Members of the type.", "nullable": true, "items": { "$ref": "#/components/schemas/EnumerationMember" } } } }, "EnumerationTypeContract": { "title": "EnumerationTypeContract", "type": "object", "description": "Enumeration type", "additionalProperties": false, "properties": { "TypeName": { "title": "String", "type": "string", "description": "Name of the type.", "nullable": true }, "Members": { "title": "EnumerationMemberContract[]", "type": "array", "description": "Members of the type.", "nullable": true, "items": { "$ref": "#/components/schemas/EnumerationMemberContract" } } } }, "ErrorData": { "title": "ErrorData", "type": "object", "description": "Error model to represent exceptions thrown from service requests", "additionalProperties": false, "required": [ "SdkErrorId" ], "properties": { "ErrorMessage": { "title": "String", "type": "string", "description": "The message that describes the current exception.", "nullable": true, "example": "Object does not exist." }, "SdkErrorId": { "title": "String", "type": "string", "description": "The developer-defined identifier of the error.", "minLength": 1, "example": "UnknownObject" }, "ErrorType": { "title": "String", "type": "string", "description": "The runtime type of the current exception.", "nullable": true, "example": "ObjectNotFoundException" }, "ErrorDetails": { "title": "String", "type": "string", "description": "The additional details.", "nullable": true, "example": "null" }, "SupportLink": { "title": "String", "type": "string", "description": "The support url.", "nullable": true, "example": "https://docs.citrix.com/en-us/urls/xd715-0001.html" }, "ErrorReportXml": { "title": "String", "type": "string", "description": "Represents a citrix.com error report.", "nullable": true, "example": "null" }, "ErrorReport": { "description": "The error report for uploading to CER.", "nullable": true, "example": "null", "$ref": "#/components/schemas/ErrorReport" } } }, "ErrorReport": { "title": "ErrorReport", "type": "object", "description": "The error data that will be submitted to the Citrix Error Reporting service", "additionalProperties": false, "required": [ "CitrixErrorId", "ComponentName", "ComponentVersion", "ErrorData" ], "properties": { "CitrixErrorId": { "title": "String", "type": "string", "description": "Gets or sets CitrixErrorId", "minLength": 1 }, "ComponentName": { "title": "String", "type": "string", "description": "Gets or sets the name of the component that threw the error", "minLength": 1 }, "ComponentVersion": { "title": "String", "type": "string", "description": "Gets or sets the version of the component that threw the error\n ", "minLength": 1 }, "ErrorData": { "title": "IDictionary`2", "type": "object", "description": "Gets Key/value pairs of error information to be added to the error report", "additionalProperties": { "title": "String", "type": "string" } } } }, "ErrorResponse": { "title": "ErrorResponse", "type": "object", "description": "Common error response model mandated by API guidelines", "additionalProperties": false, "required": [ "type", "detail" ], "properties": { "type": { "title": "String", "type": "string", "description": "URI that indicates the type of error that occurred (need not be actually accessible).\nThe format is: https://errors-api.cloud.com/{service}/{error} ", "minLength": 1, "example": "https://errors-api.cloud.com/common/authentication" }, "detail": { "title": "String", "type": "string", "description": "Human-readable description of the error that occurred, localized into the caller's language.", "minLength": 1, "example": "Missing or invalid authentication details" }, "parameters": { "title": "IList`1", "type": "array", "description": "Additional properties that an automated client may need in order to property detect and handle the error.", "nullable": true, "items": { "$ref": "#/components/schemas/ErrorResponseParameter" } } } }, "ErrorResponseParameter": { "title": "ErrorResponseParameter", "type": "object", "description": "Name/Value pair model used in ErrorResponse model", "additionalProperties": false, "required": [ "name", "value" ], "properties": { "name": { "title": "String", "type": "string", "description": "Name of a parameter.", "minLength": 1, "example": "reason" }, "value": { "title": "String", "type": "string", "description": "Value of a parameter.", "minLength": 1, "example": "invalid" } } }, "ErrorWarningModel": { "title": "ErrorWarningModel", "type": "object", "description": "Model for error and warning counts.", "additionalProperties": false, "properties": { "NumberOfErrors": { "title": "Int32", "type": "integer", "format": "int32" }, "NumberOfWarnings": { "title": "Int32", "type": "integer", "format": "int32" } } }, "ErrorWarningResponseModel": { "title": "ErrorWarningResponseModel", "type": "object", "description": "Error and warning response model", "additionalProperties": false, "properties": { "Machine": { "description": "Errors and warnings for Machine", "nullable": true, "$ref": "#/components/schemas/ErrorWarningModel" }, "DeliveryGroup": { "description": "Errors and warnings for Delivery Group", "nullable": true, "$ref": "#/components/schemas/ErrorWarningModel" }, "MachineCatalog": { "description": "Errors and warnings for Machine Catalog", "nullable": true, "$ref": "#/components/schemas/ErrorWarningModel" }, "Hypervisor": { "description": "Errors and warnings for Hosting", "nullable": true, "$ref": "#/components/schemas/ErrorWarningModel" }, "Image": { "description": "Errors and warnings for Image", "nullable": true, "$ref": "#/components/schemas/ImagesErrorWarningModel" }, "Zone": { "description": "Errors and warnings for Zone", "nullable": true, "$ref": "#/components/schemas/ZonesErrorWarningModel" }, "Site": { "description": "Errors and warnings for Site", "nullable": true, "$ref": "#/components/schemas/SitesErrorWarningModel" }, "Licensing": { "description": "Errors and warnings for Licensing", "nullable": true, "$ref": "#/components/schemas/LicenseErrorWarningModel" }, "ServiceAccount": { "description": "Error and warning for Service Account", "nullable": true, "$ref": "#/components/schemas/ErrorWarningModel" } } }, "ExportMachineCatalogResponseModel": { "title": "ExportMachineCatalogResponseModel", "type": "object", "description": "ExportMachineCatalogResponseModel class.", "additionalProperties": false, "properties": { "ProvisioningSchemeData": { "title": "String", "type": "string", "description": "The provisioning scheme in the form of a JSON encoded string.", "nullable": true }, "IdentityPoolData": { "title": "String", "type": "string", "description": "The identity pool in the form of a JSON encoded string.", "nullable": true } } }, "ExportMachineProfileResponseModel": { "title": "ExportMachineProfileResponseModel", "type": "object", "description": "ExportMachineProfileResponseModel class.", "additionalProperties": false, "properties": { "Content": { "title": "String", "type": "string", "description": "The content of the exported machine profile in the form of a JSON string.", "nullable": true } } }, "FastApplicationSettingsRequestModel": { "title": "FastApplicationSettingsRequestModel", "type": "object", "description": "Request object for session prelaunch and lingering settings.", "additionalProperties": false, "properties": { "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates if the pre-launch or lingering settings are enabled.", "default": true, "nullable": true }, "MaxAverageLoadThreshold": { "title": "Int32", "type": "integer", "description": "Specifies the average load threshold across the delivery group\nbefore pre-launched or lingering sessions will be terminated.\nWhen the threshold hits, sessions which have been pre-launched\nor which have lingered the longest will be terminated to reduce\nload.", "format": "int32", "default": 0, "nullable": true }, "MaxLoadPerMachineThreshold": { "title": "Int32", "type": "integer", "description": "Specifies the maximum load threshold per machine in the\ndelivery group before pre-launched or lingering sessions\nwill be terminated.\nWhen the threshold hits, sessions which have been pre-launched\nor which have lingered the longest on each loaded machine will\nbe terminated to reduce load.\nWas: public int? MaxPerDesktopLoadThreshold { get; set; }", "format": "int32", "default": 0, "nullable": true }, "MaxTimeBeforeDisconnectMinutes": { "title": "Int32", "type": "integer", "description": "Specifies the time by which a pre-launched or lingering\nsession will be disconnected.", "format": "int32", "default": 0, "nullable": true }, "MaxTimeBeforeTerminateMinutes": { "title": "Int32", "type": "integer", "description": "Specifies the time by which a pre-launched or lingering\nsession will be terminated.", "format": "int32", "default": 0, "nullable": true }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedUsers filter\nis enabled or disabled. When the user filter is enabled,\npre-launch or lingering are enabled only to users who\nappear in the filter (either explicitly or by virtue of\ngroup membership).\nWas: UserFilterEnabled", "default": false, "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the users and user groups to whom the pre-launch\nor lingering settings apply.\nWas: users", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } } } }, "FastApplicationSettingsResponseModel": { "title": "FastApplicationSettingsResponseModel", "type": "object", "description": "Response object used for session pre-launch and lingering settings.", "additionalProperties": false, "required": [ "Enabled", "MaxAverageLoadThreshold", "MaxLoadPerMachineThreshold", "MaxTimeBeforeDisconnectMinutes", "MaxTimeBeforeTerminateMinutes", "IncludedUserFilterEnabled" ], "properties": { "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates if the pre-launch or lingering settings are enabled." }, "MaxAverageLoadThreshold": { "title": "Int32", "type": "integer", "description": "Indicates the average load threshold across the delivery group\nbefore pre-launched or lingering sessions will be terminated.\nWhen the threshold hits, sessions which have been pre-launched\nor which have lingered the longest will be terminated to reduce\nload.", "format": "int32" }, "MaxLoadPerMachineThreshold": { "title": "Int32", "type": "integer", "description": "Indicates the maximum load threshold per machine in the\ndelivery group before pre-launched or lingering sessions\nwill be terminated.\nWhen the threshold hits, sessions which have been pre-launched\nor which have lingered the longest on each loaded machine will\nbe terminated to reduce load.", "format": "int32" }, "MaxTimeBeforeDisconnectMinutes": { "title": "Int32", "type": "integer", "description": "Specifies the time by which a pre-launched or lingering\nsession will be disconnected.", "format": "int32" }, "MaxTimeBeforeTerminateMinutes": { "title": "Int32", "type": "integer", "description": "Specifies the time by which a pre-launched or lingering\nsession will be terminated.", "format": "int32" }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedUsers filter\nis enabled or disabled. When the user filter is enabled,\npre-launch or lingering are enabled only to users who\nappear in the filter (either explicitly or by virtue of\ngroup membership)." }, "IncludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "Indicates the users and user groups to whom the pre-launch\nor lingering settings apply.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } } } }, "FaultState": { "title": "FaultState", "type": "string", "description": "Fault states for machines.", "x-enumNames": [ "Unknown", "None", "FailedToStart", "StuckOnBoot", "Unregistered", "MaxCapacity", "VirtualMachineNotFound", "MaxCapacityVerticalLoadBalancing" ], "enum": [ "Unknown", "None", "FailedToStart", "StuckOnBoot", "Unregistered", "MaxCapacity", "VirtualMachineNotFound", "MaxCapacityVerticalLoadBalancing" ] }, "FilterDefinition": { "title": "FilterDefinition", "type": "object", "description": "Filter definition.", "additionalProperties": false, "properties": { "filterType": { "description": "Filter type.", "$ref": "#/components/schemas/FilterType" }, "filterName": { "title": "String", "type": "string", "description": "Localized filter name.", "nullable": true }, "explanation": { "title": "String", "type": "string", "description": "Localized explanation.", "nullable": true }, "isUserFilter": { "title": "Boolean", "type": "boolean", "description": "True = user filter, False = machine filter." }, "isSingleton": { "title": "Boolean", "type": "boolean", "description": "Is filter a singleton, only the Citrix SD-Wan filter is singleton." } } }, "FilterDefinitionContract": { "title": "FilterDefinitionContract", "type": "object", "description": "Filter definition.", "additionalProperties": false, "properties": { "FilterType": { "title": "String", "type": "string", "description": "Filter type", "nullable": true }, "FilterName": { "title": "String", "type": "string", "description": "Localized filter name", "nullable": true }, "Explanation": { "title": "String", "type": "string", "description": "Localized explanation", "nullable": true }, "IsUserFilter": { "title": "Boolean", "type": "boolean", "description": "True = user filter, False = machine filter" } } }, "FilterDetail": { "title": "FilterDetail", "type": "object", "description": "Detailed information about filter.", "additionalProperties": false, "properties": { "FilterType": { "description": "Filter type.", "$ref": "#/components/schemas/FilterType2" }, "FilterValue": { "title": "String", "type": "string", "description": "Filter value, if available.", "nullable": true }, "IsMatched": { "title": "Boolean", "type": "boolean", "description": "Indicate if the filter is a match." }, "FilterData": { "title": "String", "type": "string", "description": "The filter data. This may need to get translated to a user readable string.", "nullable": true }, "IsWithout": { "title": "Boolean", "type": "boolean", "description": "Valid only for the branch repeater filter and access control filter. Indicate the mode or condition.", "nullable": true }, "Gateway": { "title": "String", "type": "string", "description": "Valid only for the access control filter. The access gateway.", "nullable": true } } }, "FilterMatchType": { "title": "FilterMatchType", "type": "string", "description": "", "x-enumNames": [ "Unknown", "MatchAny", "MatchAll" ], "enum": [ "Unknown", "MatchAny", "MatchAll" ] }, "FilterProperty": { "title": "FilterProperty", "type": "string", "description": "Names of filter properties that can be specified in a search.", "x-enumNames": [ "FilterData", "FilterType", "IsAllowed", "IsEnabled" ], "enum": [ "FilterData", "FilterType", "IsAllowed", "IsEnabled" ] }, "FilterRequest": { "title": "FilterRequest", "type": "object", "description": "Data for specifying a filter request.", "additionalProperties": false, "properties": { "filterType": { "title": "String", "type": "string", "description": "The filter type.", "nullable": true }, "isAllowed": { "title": "Boolean", "type": "boolean", "description": "Filtered policy is allowed or denied if the filter condition is met." }, "isEnabled": { "title": "Boolean", "type": "boolean", "description": "Filter is enabled or disabled." }, "filterData": { "title": "String", "type": "string", "description": "Filter data as a serialized JSON string. This is ignored if the filter is a Citrix SD-Wan filter.", "nullable": true } } }, "FilterRequestContract": { "title": "FilterRequestContract", "type": "object", "description": "Filter definition", "additionalProperties": false, "properties": { "FilterType": { "title": "String", "type": "string", "description": "The filter name, or filter type.", "nullable": true }, "FilterName": { "title": "String", "type": "string", "description": "The filter name.", "nullable": true }, "IsAllowed": { "title": "Boolean", "type": "boolean", "description": "Allow or deny", "default": false, "nullable": true }, "IsEnabled": { "title": "Boolean", "type": "boolean", "description": "Enabled or disabled", "default": false, "nullable": true }, "FilterValue": { "title": "String", "type": "string", "description": "Serialized JSON string.", "nullable": true } } }, "FilterResponse": { "title": "FilterResponse", "type": "object", "description": "Filter response.", "additionalProperties": false, "properties": { "policyGuid": { "title": "Guid", "type": "string", "description": "GUID of the policy that owns this filter.", "format": "guid" }, "filterType": { "title": "String", "type": "string", "description": "The filter type.", "nullable": true }, "filterGuid": { "title": "Guid", "type": "string", "description": "The filter Guid.", "format": "guid" }, "isAllowed": { "title": "Boolean", "type": "boolean", "description": "The filtered policy is allowed or denied if the filter condition is met." }, "isEnabled": { "title": "Boolean", "type": "boolean", "description": "Is filter enabled or disabled." }, "filterData": { "title": "String", "type": "string", "description": "The data for the filter as a JSON string. This is ignored if the filter is Citrix SD-Wan.", "nullable": true } } }, "FilterResponseContract": { "title": "FilterResponseContract", "type": "object", "description": "Filter definition", "additionalProperties": false, "properties": { "FilterType": { "title": "String", "type": "string", "description": "The filter type.", "nullable": true }, "Identifier": { "title": "String", "type": "string", "description": "The filter name.", "nullable": true }, "DisplayName": { "title": "String", "type": "string", "description": "Filter display name, this is translated and unique.", "nullable": true }, "IsSingleton": { "title": "Boolean", "type": "boolean", "description": "Is filter a singleton, only the NetScaler SD-Wan filter is singleton." }, "Explanation": { "title": "String", "type": "string", "description": "Translated filter explanation.", "nullable": true }, "Synopsis": { "title": "String", "type": "string", "description": "A summary of filter value.", "nullable": true }, "IsUserFilter": { "title": "Boolean", "type": "boolean", "description": "True = user filter, False = machine filter" }, "IsAllowed": { "title": "Boolean", "type": "boolean", "description": "Allow or deny", "nullable": true }, "IsEnabled": { "title": "Boolean", "type": "boolean", "description": "Enabled or disabled", "nullable": true }, "FilterValue": { "title": "String", "type": "string", "description": "Serialized JSON string.", "nullable": true } } }, "FilterSearch": { "title": "FilterSearch", "type": "object", "description": "Filter search data.", "additionalProperties": false, "properties": { "SearchFilters": { "title": "SearchFilter[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/SearchFilter4" } }, "SortCriteria": { "description": "Sort criteria for the results. If no sort criteria is specified, the results are unsorted.", "nullable": true, "$ref": "#/components/schemas/SortingMethod4" } } }, "FilterType": { "title": "FilterType", "type": "string", "description": "Names of all filters. The names get stored. So they must not be changed. Filter types are stored in the database\nas integers. These are the values defined as GPOFTXxx values in the SQL filter definitions, e.g., GPOFTUser. The\nnumbers are explicitly assigned here so that the values stored in the database are always correct even in case\nany changes are made here. We should never delete a filter type, nor change the numerical value of a filter type,\nalthough the enum name may be changed.", "x-enumNames": [ "AccessControl", "BranchRepeater", "ClientIP", "ClientName", "DesktopGroup", "DesktopKind", "DesktopTag", "OU", "User", "SecureBrowserTag", "ClientPlatform" ], "enum": [ "AccessControl", "BranchRepeater", "ClientIP", "ClientName", "DesktopGroup", "DesktopKind", "DesktopTag", "OU", "User", "SecureBrowserTag", "ClientPlatform" ] }, "FilterType2": { "title": "FilterType", "type": "string", "description": "Names of all filters. The names get stored. So they must not be changed. Filter types are stored in the database\nas integers. These are the values defined as GPOFTXxx values in the SQL filter definitions, e.g., GPOFTUser. The\nnumbers are explicitly assigned here so that the values stored in the database are always correct even in case\nany changes are made here. We should never delete a filter type, nor change the numerical value of a filter type,\nalthough the enum name may be changed.", "x-enumNames": [ "AccessControl", "BranchRepeater", "ClientIP", "ClientName", "DesktopGroup", "DesktopKind", "DesktopTag", "OU", "User", "SecureBrowserTag", "ClientPlatform" ], "enum": [ "AccessControl", "BranchRepeater", "ClientIP", "ClientName", "DesktopGroup", "DesktopKind", "DesktopTag", "OU", "User", "SecureBrowserTag", "ClientPlatform" ] }, "FixupSeverity": { "title": "FixupSeverity", "type": "string", "description": "", "x-enumNames": [ "Normal", "Info", "Warning", "Error", "Undefined" ], "enum": [ "Normal", "Info", "Warning", "Error", "Undefined" ] }, "FtaRequestModel": { "title": "FtaRequestModel", "type": "object", "description": "Request object for a file-type association.", "additionalProperties": false, "required": [ "ExtensionName" ], "properties": { "ContentType": { "title": "String", "type": "string", "description": "Content-type. (Mime type)\n\nOptional. If not specified, and an imported file type exists for the\napplication with the same ExtensionName, this value will be\nretained. Otherwise the default is an empty string.", "maxLength": 255, "pattern": "^[A-Za-z]+$", "nullable": true, "example": "For example, application/json" }, "ExtensionName": { "title": "String", "type": "string", "description": "The extension name for the file type association. For example, \".txt\" or\n\".doc\".\n\n\nRequired. When enabling a file type association for an application, the\nextension name must not already be enabled for the same application. To\nchange properties of an already-enabled file type association, disable the\nfile type association first.", "maxLength": 255, "minLength": 1, "pattern": "\\..+", "example": "For example, .txt" }, "Description": { "title": "String", "type": "string", "description": "The description of the handler for the file type association.\n\n\nOptional. If not specified, and an imported file type exists for the\napplication with the same , this value will be\nretained. Otherwise the default is an empty string.", "maxLength": 512, "pattern": "(.*)*", "nullable": true, "example": "The description of the handler" }, "HandlerName": { "title": "String", "type": "string", "description": "The name of the handler for the file type association (as seen in the\nRegistry).\n\n\nOptional. If not specified, a handler name will be chosen automatically based\non the application's .\nIn most cases, callers should NOT override the default behavior and should not\npass a value for this property.", "maxLength": 255, "pattern": "^[A-Za-z]+$", "nullable": true, "example": "Name of the handler" }, "OpenArguments": { "title": "String", "type": "string", "description": "The arguments for the open command that the handler should use. For example, \"%1\".\n\n\nRequired. When enabling a file type association for an application, the\nextension name must not already be enabled for the same application. To\nchange properties of an already-enabled file type association, you must\ndisable the file type association first.", "maxLength": 255, "pattern": "^[A-Za-z]+$", "nullable": true, "example": "For example, %1" } } }, "FtaResponseModel": { "title": "FtaResponseModel", "type": "object", "description": "Response object for a file-type association.", "additionalProperties": false, "required": [ "ExtensionName", "HandlerName", "Enabled", "IsImported" ], "properties": { "ContentType": { "title": "String", "type": "string", "description": "Content-type. (Mime type)", "nullable": true }, "ExtensionName": { "title": "String", "type": "string", "description": "The extension name for the file type association. For example, \".txt\" or \".doc\".", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "The description of the handler for the file type association.", "nullable": true }, "HandlerName": { "title": "String", "type": "string", "description": "The name of the handler for the file type association (as seen in the\nRegistry). For example, \"TXTFILE\" or \"Word.Document.8\".", "minLength": 1 }, "OpenArguments": { "title": "String", "type": "string", "description": "The arguments for the open command that the handler should use. For example, \"%1\".", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates if the file type association is enabled; i.e. whether users who\nreceive the application will launch files of this type using the published\napplication." }, "IsImported": { "title": "Boolean", "type": "boolean", "description": "Indicates if the file type association was imported, as opposed to explicitly\nadded. File type associations which are not imported will be deleted when\ndisabled." } } }, "FtaResponseModelCollection": { "title": "FtaResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfFtaResponseModel" }, { "type": "object", "description": "file-type association response model collection", "additionalProperties": false } ] }, "FunctionalLevel": { "title": "FunctionalLevel", "type": "string", "description": "Functional level for VDAs.", "x-enumNames": [ "Unknown", "L5", "LMIN", "L7", "L7_6", "L7_7", "L7_8", "L7_9", "L7_20", "L7_25", "L7_30", "L7_34", "LMAX" ], "enum": [ "Unknown", "L5", "LMIN", "L7", "L7_6", "L7_7", "L7_8", "L7_9", "L7_20", "L7_25", "L7_30", "L7_34", "LMAX" ] }, "GpoTestFilterData": { "title": "GpoTestFilterData", "type": "object", "description": "Data for a filter whose value may have an error.", "additionalProperties": false, "properties": { "errorCode": { "title": "String", "type": "string", "description": "Error code.", "nullable": true }, "errorMessage": { "title": "String", "type": "string", "description": "Additional error message about the filter value.", "nullable": true }, "filterType": { "title": "String", "type": "string", "description": "The filter type.", "nullable": true }, "filterValue": { "title": "String", "type": "string", "description": "The filter value.", "nullable": true } } }, "GpoTestPolicyData": { "title": "GpoTestPolicyData", "type": "object", "description": "Policy data from the output of the Test-BrokerDesktopPolicy command.", "additionalProperties": false, "properties": { "errorCode": { "title": "String", "type": "string", "description": "Error code.", "nullable": true }, "policyName": { "title": "String", "type": "string", "description": "Policy name.", "nullable": true }, "settings": { "title": "GpoTestSettingData[]", "type": "array", "description": "Data for settings in the policy. Only settings whose values have errors may be listed.", "nullable": true, "items": { "$ref": "#/components/schemas/GpoTestSettingData" } }, "filters": { "title": "GpoTestFilterData[]", "type": "array", "description": "Data for filters in the policy. Only filters whose values have errors may be listed.", "nullable": true, "items": { "$ref": "#/components/schemas/GpoTestFilterData" } } } }, "GpoTestSettingData": { "title": "GpoTestSettingData", "type": "object", "description": "Data for a setting whose value may have an error.", "additionalProperties": false, "properties": { "errorCode": { "title": "String", "type": "string", "description": "Error code.", "nullable": true }, "errorMessage": { "title": "String", "type": "string", "description": "Additional error message about the setting value.", "nullable": true }, "settingName": { "title": "String", "type": "string", "description": "The name of the setting.", "nullable": true }, "settingValue": { "title": "String", "type": "string", "description": "The value of the setting.", "nullable": true } } }, "HardwareSchemeUpdateTaskDetailResponseModel": { "title": "HardwareSchemeUpdateTaskDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/MaintenanceCycleTaskDetailResponseModel" }, { "type": "object", "description": "Response object for a task of hardware scheme update.", "additionalProperties": false, "properties": { "ProvisioningSchemeConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The version of provisioning scheme version. It is the version applied when the machine catalog hardware update is created.", "format": "int32" } } } ] }, "HardwareVmUpdateTaskDetailResponseModel": { "title": "HardwareVmUpdateTaskDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/MaintenanceCycleTaskDetailResponseModel" }, { "type": "object", "description": "Response object for a task of hardware vm update.", "additionalProperties": false, "properties": { "ProvisionedVmConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The version of provisioned VM configuration version. It is the version applied when the VM hardware update is created.", "format": "int32", "nullable": true }, "ProvisioningSchemeConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The version of provisioning scheme version. It is the version applied when the VM hardware update is created.", "format": "int32", "nullable": true } } } ] }, "HolidayAutoscaleGroupPluginResponseModel": { "title": "HolidayAutoscaleGroupPluginResponseModel", "allOf": [ { "$ref": "#/components/schemas/AutoscaleGroupPluginResponseModel" }, { "type": "object", "description": "Holiday autoscale group plugin response model.", "additionalProperties": false, "properties": { "Dates": { "title": "String[]", "type": "array", "description": "Holiday dates in yyyy-MM-dd format.", "nullable": true, "items": { "title": "String", "type": "string" } }, "OverrideTimeSchemeUid": { "title": "Int32", "type": "integer", "description": "A power time scheme UID to use for holiday days.", "format": "int32", "nullable": true } } } ] }, "HomeZoneMode": { "title": "HomeZoneMode", "type": "string", "description": "Modes by which the system may choose to use a user's or\napplication's home zone.", "x-enumNames": [ "Unknown", "Prefer", "Ignore", "Only", "User" ], "enum": [ "Unknown", "Prefer", "Ignore", "Only", "User" ] }, "HypervisorAllResourceSearchRequestModel": { "title": "HypervisorAllResourceSearchRequestModel", "type": "object", "description": "Request model for searching all resources in a hypervisor without connection.", "additionalProperties": false, "required": [ "ConnectionDetail", "ResourceSearchRequest" ], "properties": { "ConnectionDetail": { "description": "Details of how to connect to the hypervisor. See HypervisorConnectionDetailRequestModel.", "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, "ResourceSearchRequest": { "description": "Resource search request. See HypervisorResourceSearchRequestModel.", "$ref": "#/components/schemas/HypervisorResourceSearchRequestModel" } } }, "HypervisorAvailabilityZoneResourceResponseModel": { "title": "HypervisorAvailabilityZoneResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "SupportsSecurityGroups" ], "properties": { "SupportsSecurityGroups": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this zone supports the use of security groups for isolation." } } } ] }, "HypervisorAWCConnectionDetailRequestModel": { "title": "HypervisorAWCConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "description": "Hypervisor connection details for Amazon WorkSpaces Core.", "additionalProperties": false, "required": [ "ApiKey", "SecretKey" ], "properties": { "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the Amazon WorkSpaces Core APIs. Required.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "SecretKey": { "title": "String", "type": "string", "description": "The secret key used to authenticate with the Amazon WorkSpaces Core APIs. Required.\nMust be specified in the format indicated by\nSecretKeyFormat.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "SecretKeyFormat": { "description": "Format of the SecretKey. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Region": { "title": "String", "type": "string", "description": "Amazon WorkSpaces Core region to connect to. Optional. If not specified, will connect\nto the global Amazon WorkSpaces Core APIs. This can be used to discover the regions\navailable within Amazon WorkSpaces Core. Access to all other Amazon WorkSpaces Core resources requires\nthe region to be set explicitly.", "maxLength": 16, "pattern": "(.*)*", "nullable": true }, "Address": { "title": "String", "type": "string", "description": "Custom Amazon WorkSpaces Core Address.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "HypervisorAWSConnectionDetailRequestModel": { "title": "HypervisorAWSConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "ApiKey", "SecretKey" ], "properties": { "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the AWS APIs. Required.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "SecretKey": { "title": "String", "type": "string", "description": "The secret key used to authenticate with the AWS APIs. Required.\nMust be specified in the format indicated by\nSecretKeyFormat.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "SecretKeyFormat": { "description": "Format of the SecretKey. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Region": { "title": "String", "type": "string", "description": "AWS region to connect to. Optional. If not specified, will connect\nto the global AWS APIs. This can be used to discover the regions\navailable within AWS. Access to all other AWS resources requires\nthe region to be set explicitly.", "maxLength": 16, "pattern": "(.*)*", "nullable": true }, "Address": { "title": "String", "type": "string", "description": "Custom AWS Address.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "HypervisorAzureArcConnectionDetailRequestModel": { "title": "HypervisorAzureArcConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "ApplicationId", "ApplicationSecret", "SubscriptionId", "ActiveDirectoryId" ], "properties": { "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure\nArc APIs. Required.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "ApplicationSecret": { "title": "String", "type": "string", "description": "The Application Secret of the service principal used to access the\nAzure APIs. Required. Must be specified in the format indicated by\nApplicationSecretFormat.", "maxLength": 20480, "minLength": 1 }, "ApplicationSecretFormat": { "description": "Format of the ApplicationSecret. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "SubscriptionId": { "title": "String", "type": "string", "description": "Azure subscription ID. Required.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "ActiveDirectoryId": { "title": "String", "type": "string", "description": "Microsoft Entra tenant ID. Required.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "Environment": { "description": "Azure environment. Optional. Default is\nAzureCloud.", "default": "AzureCloud", "nullable": true, "$ref": "#/components/schemas/AzureEnvironment" }, "ManagementEndpoint": { "title": "String", "type": "string", "description": "Azure management endpoint. Required if\nEnvironment is Custom.\nOptional otherwise.", "maxLength": 2083, "pattern": "(.*)*", "nullable": true }, "AuthenticationAuthority": { "title": "String", "type": "string", "description": "Azure authentication authority. Required if\nEnvironment is Custom.\nOptional otherwise.", "maxLength": 2083, "pattern": "(.*)*", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "HypervisorAzureConnectionDetailRequestModel": { "title": "HypervisorAzureConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "ApplicationId", "ApplicationSecret", "SubscriptionId", "ActiveDirectoryId" ], "properties": { "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure\nAPIs. Required for AuthenticationMode in CustomProperties is AppClientSecret\nor UserAssignedManagedIdentity.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "ApplicationSecret": { "title": "String", "type": "string", "description": "The Application Secret of the service principal used to access the\nAzure APIs. Required for AuthenticationMode in CustomProperties is AppClientSecret.\nMust be specified in the format indicated by\nApplicationSecretFormat.", "maxLength": 20480, "minLength": 1 }, "ApplicationSecretFormat": { "description": "Format of the ApplicationSecret. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "SubscriptionId": { "title": "String", "type": "string", "description": "Azure subscription ID. Required.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "ActiveDirectoryId": { "title": "String", "type": "string", "description": "Microsoft Entra tenant ID. Required.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "Environment": { "description": "Azure environment. Optional. Default is\nAzureCloud.", "default": "AzureCloud", "nullable": true, "$ref": "#/components/schemas/AzureEnvironment" }, "ManagementEndpoint": { "title": "String", "type": "string", "description": "Azure management endpoint. Required if\nEnvironment is Custom.\nOptional otherwise.", "maxLength": 2083, "pattern": "(.*)*", "nullable": true }, "AuthenticationAuthority": { "title": "String", "type": "string", "description": "Azure authentication authority. Required if\nEnvironment is Custom.\nOptional otherwise.", "maxLength": 2083, "pattern": "(.*)*", "nullable": true }, "StorageSuffix": { "title": "String", "type": "string", "description": "Azure storage suffix. Required if\nEnvironment is Custom.\nOptional otherwise.", "maxLength": 2083, "pattern": "(.*)*", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "HypervisorAzureEnvironmentResponseModel": { "title": "HypervisorAzureEnvironmentResponseModel", "type": "object", "description": "Azure rm environment instance, which used for front end Azure environment show.", "additionalProperties": false, "properties": { "EnvironmentDisplayName": { "title": "String", "type": "string", "description": "Environment display name which used to show on the front end.\ne.g. Azure Global, Azure China and Azure US Government.", "nullable": true }, "EnvironmentName": { "description": "The environment name which used for identity the data for background.\ne.g. AzureCloud, AzureChinaCloud and AzureUSGovernment.", "$ref": "#/components/schemas/AzureEnvironment" } } }, "HypervisorBaseResponseModel": { "title": "HypervisorBaseResponseModel", "type": "object", "description": "Hypervisor base response model", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the resource.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the resource.", "nullable": true }, "XDPath": { "title": "String", "type": "string", "description": "XenApp & XenDesktop path to the resource\non the hypervisor. An example value is:\n`XDHyp:\\Connections\\{{hypervisor name}}\\{{vm name}}.vm\\{{snapshot name}}.snapshot`\nor\n`XDHyp:\\HostingUnits\\{{resource pool name}}\\{{resource name}}.{{resource type}}`", "nullable": true } } }, "HypervisorCloudRegionResourceResponseModel": { "title": "HypervisorCloudRegionResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceResponseModel" }, { "type": "object", "additionalProperties": false, "properties": { "Endpoint": { "title": "String", "type": "string", "description": "The API address with the region.", "nullable": true } } } ] }, "HypervisorConfigurationObjectCapability": { "title": "HypervisorConfigurationObjectCapability", "type": "object", "description": "Capabilities for a specific type of resource on a hypervisor.", "additionalProperties": false, "properties": { "ResourceType": { "title": "String", "type": "string", "description": "Type of hypervisor resource.", "nullable": true }, "TypeCapabilities": { "title": "String[]", "type": "array", "description": "List of capabilities.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "HypervisorConnectionDetailRequestModel": { "title": "HypervisorConnectionDetailRequestModel", "type": "object", "description": "Hypervisor connection details.", "additionalProperties": false, "required": [ "Name", "ConnectionType" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the hypervisor to create. Required.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*", "example": "Name of the hypervisor" }, "ConnectionType": { "description": "Hypervisor connection type. Required.", "$ref": "#/components/schemas/HypervisorConnectionType" }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the newly created hypervisor will be a\npart of.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenant(s) to associate the hypervisor with.", "nullable": true, "example": [ "Name or id of a tenant" ], "items": { "title": "String", "type": "string" } }, "MaxAbsoluteActiveActions": { "title": "Int32", "type": "integer", "description": "Maximum number of actions that can execute in parallel on the\nhypervisor. Optional; if not specified, an appropriate default is\nselected based on the ConnectionType.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "MaxAbsoluteNewActionsPerMinute": { "title": "Int32", "type": "integer", "description": "Maximum number of actions that can be started on the hypervisor\nper-minute. Optional; if not specified, an appropriate default is\nselected based on the ConnectionType.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "MaxPowerActionsPercentageOfMachines": { "title": "Int32", "type": "integer", "description": "Maximum percentage of machines on the hypervisor which can have\ntheir power state changed simultaneously. Optional; if not\nspecified, an appropriate default is selected based on the\nConnectionType.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "ConnectionOptions": { "title": "String", "type": "string", "description": "Connection options to use for the hypervisor. Optional.", "maxLength": 1000, "pattern": "((.|\\n)*)", "nullable": true, "example": "Connection options" }, "Zone": { "title": "String", "type": "string", "description": "Zone the hypervisor is associated with. Optional.\nIf not specified, the hypervisor is associated with the primary zone.\nSee PrimaryZone.", "nullable": true, "example": "Name or id of a zone" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata to use for the hypervisor. Optional.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the AWS APIs. Required.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "SecretKey": { "title": "String", "type": "string", "description": "The secret key used to authenticate with the AWS APIs. Required.\nMust be specified in the format indicated by\nSecretKeyFormat.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "SecretKeyFormat": { "description": "Format of the SecretKey. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Region": { "title": "String", "type": "string", "description": "AWS region to connect to. Optional. If not specified, will connect\nto the global AWS APIs. This can be used to discover the regions\navailable within AWS. Access to all other AWS resources requires\nthe region to be set explicitly.", "maxLength": 16, "pattern": "(.*)*", "nullable": true }, "Address": { "title": "String", "type": "string", "description": "Custom AWS Address.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true }, "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure\nAPIs. Required for AuthenticationMode in CustomProperties is AppClientSecret\nor UserAssignedManagedIdentity.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "ApplicationSecret": { "title": "String", "type": "string", "description": "The Application Secret of the service principal used to access the\nAzure APIs. Required for AuthenticationMode in CustomProperties is AppClientSecret.\nMust be specified in the format indicated by\nApplicationSecretFormat.", "maxLength": 20480, "minLength": 1 }, "ApplicationSecretFormat": { "description": "Format of the ApplicationSecret. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "SubscriptionId": { "title": "String", "type": "string", "description": "Azure subscription ID. Required.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "ActiveDirectoryId": { "title": "String", "type": "string", "description": "Microsoft Entra tenant ID. Required.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "Environment": { "description": "Azure environment. Optional. Default is\nAzureCloud.", "default": "AzureCloud", "nullable": true, "$ref": "#/components/schemas/AzureEnvironment" }, "ManagementEndpoint": { "title": "String", "type": "string", "description": "Azure management endpoint. Required if\nEnvironment is Custom.\nOptional otherwise.", "maxLength": 2083, "pattern": "(.*)*", "nullable": true }, "AuthenticationAuthority": { "title": "String", "type": "string", "description": "Azure authentication authority. Required if\nEnvironment is Custom.\nOptional otherwise.", "maxLength": 2083, "pattern": "(.*)*", "nullable": true }, "StorageSuffix": { "title": "String", "type": "string", "description": "Azure storage suffix. Required if\nEnvironment is Custom.\nOptional otherwise.", "maxLength": 2083, "pattern": "(.*)*", "nullable": true }, "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Google Cloud APIs.\nRequired.", "maxLength": 512, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountCredentials": { "title": "String", "type": "string", "description": "the JSON-encoded service account credentials used to access the\nGoogle Cloud APIs. Required. Must be specified in the format\nindicated by ServiceAccountCredentialsFormat.", "maxLength": 2147483647, "minLength": 1, "pattern": "((.|\\n)*)" }, "ServiceAccountCredentialsFormat": { "description": "Format of the ServiceAccountCredentials. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "UserName": { "title": "String", "type": "string", "description": "Hypervisor username. Required.", "maxLength": 256, "minLength": 1, "pattern": "(.*)*" }, "Password": { "title": "String", "type": "string", "description": "Hypervisor password. Required. Must be specified in the format\nindicated by PasswordFormat.", "maxLength": 20480, "minLength": 1, "pattern": "(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*]).{8,}|^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|(.*)*" }, "PasswordFormat": { "description": "Format of the Password. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Addresses": { "title": "String[]", "type": "array", "description": "Hypervisor address(es). At least one is required.", "items": { "title": "String", "type": "string" } }, "PluginId": { "title": "String", "type": "string", "description": "Custom hypervisor plugin ID. Required if the\nConnectionType is\nCustom. Otherwise must not\nbe specified.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL certificate thumbprints to consider acceptable for this\nconnection. Optional. If not specified, and the hypervisor uses\nSSL for its connection, the SSL certificate's root certification\nauthority and any intermediate certificates must be trusted.", "nullable": true, "items": { "title": "String", "type": "string" } }, "SccmWakeUpProxy": { "title": "Boolean", "type": "boolean", "description": "Indicates whether Microsoft System Center Configuration Manager 2012\nSP1 Wake-up Proxy is used for power management. Optional; default\nis `false`.", "nullable": true }, "WakeOnLanPackets": { "description": "Indicates the Wake on LAN packet transmission method to use for\npower management. Optional; default is ", "default": "None", "nullable": true, "$ref": "#/components/schemas/WakeOnLanTransmission" }, "TenancyOcid": { "title": "String", "type": "string", "description": "Oracle Cloud Infrastructure tenancy to connect to.\nRequired.", "maxLength": 128, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountCredential": { "title": "String", "type": "string", "description": "The private key string to access the Oracle Cloud Infrastructure APIs.\nRequired. Must be specified in the format\nindicated by ServiceAccountCredentialFormat.", "maxLength": 2147483647, "minLength": 1, "pattern": "((.|\\n)*)" }, "ServiceAccountCredentialFormat": { "description": "Format of the ServiceAccountCredential. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "ServiceAccountFingerprint": { "title": "String", "type": "string", "description": "The fingerprint of the public key associate with the ServiceAccountCredential.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "OciEnvironment": { "description": "OCI environment. Optional. Default is\nCommercial.", "default": "Commercial", "nullable": true, "$ref": "#/components/schemas/OciEnvironment" } } }, "HypervisorConnectionType": { "title": "HypervisorConnectionType", "type": "string", "description": "Types of hypervisor connections.", "x-enumNames": [ "Unknown", "XenServer", "SCVMM", "VCenter", "Custom", "AWS", "WakeOnLAN", "AzureRM", "GoogleCloudPlatform", "CloudPlatform", "OracleCloudInfrastructure", "AzureArc", "OpenShift", "AmazonWorkSpacesCore", "NutanixAhvPC", "OracleC3" ], "enum": [ "Unknown", "XenServer", "SCVMM", "VCenter", "Custom", "AWS", "WakeOnLAN", "AzureRM", "GoogleCloudPlatform", "CloudPlatform", "OracleCloudInfrastructure", "AzureArc", "OpenShift", "AmazonWorkSpacesCore", "NutanixAhvPC", "OracleC3" ] }, "HypervisorCriticalIssueType": { "title": "HypervisorCriticalIssueType", "type": "string", "description": "Represents the type of critical issue that can occur with a hypervisor.", "x-enumNames": [ "Unknown", "Broken", "SecretExpired" ], "enum": [ "Unknown", "Broken", "SecretExpired" ] }, "HypervisorDeletePreviewResponseModel": { "title": "HypervisorDeletePreviewResponseModel", "type": "object", "description": "Hypervisor Delete Preview response model.", "additionalProperties": false, "properties": { "CanBeDeleted": { "title": "Boolean", "type": "boolean", "description": "If the hypervisor can be deleted." }, "TotalImpactedCatalogCount": { "title": "Int32", "type": "integer", "description": "Totally impacted catalogs count.", "format": "int32" }, "ProvisioningSchemeReferences": { "title": "Int32", "type": "integer", "description": "Provisioning scheme references count.", "format": "int32" }, "TaskReferences": { "title": "Int32", "type": "integer", "description": "Task references count.", "format": "int32" }, "UnknownMachines": { "title": "Int32", "type": "integer", "description": "Unknown machines count.", "format": "int32" }, "HostsToBeDeleted": { "title": "String[]", "type": "array", "description": "Hosting units to be deleted.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ImpactedCatalogs": { "title": "Dictionary`2", "type": "object", "description": "Impacted catalogs dictionary.", "nullable": true, "additionalProperties": { "title": "Int32", "type": "integer", "format": "int32" } }, "ImpactedImageDefinitions": { "title": "Dictionary`2", "type": "object", "description": "Impacted image definitions dictionary.", "nullable": true, "additionalProperties": { "title": "Int32", "type": "integer", "format": "int32" } } } }, "HypervisorDetailAWCResponseModel": { "title": "HypervisorDetailAWCResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "ApiKey", "Region" ], "properties": { "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the AWS APIs.", "minLength": 1 }, "Region": { "title": "String", "type": "string", "description": "The AWS region which the hypervisor represents.", "minLength": 1 }, "MaximumConcurrentProvisioningOperations": { "title": "Int32", "type": "integer", "description": "AWS maximum concurrent provisioning operations.", "format": "int32", "nullable": true } } } ] }, "HypervisorDetailAWSResponseModel": { "title": "HypervisorDetailAWSResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "ApiKey", "Region" ], "properties": { "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the AWS APIs.", "minLength": 1 }, "Region": { "title": "String", "type": "string", "description": "The AWS region which the hypervisor represents.", "minLength": 1 }, "MaximumConcurrentProvisioningOperations": { "title": "Int32", "type": "integer", "description": "AWS maximum concurrent provisioning operations.", "format": "int32", "nullable": true } } } ] }, "HypervisorDetailAzureArcResponseModel": { "title": "HypervisorDetailAzureArcResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "ApplicationId", "SubscriptionId", "ActiveDirectoryId", "Environment", "ManagementEndpoint", "AuthenticationAuthority" ], "properties": { "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure Arc\nAPIs.", "minLength": 1 }, "SubscriptionId": { "title": "String", "type": "string", "description": "Azure subscription ID.", "minLength": 1 }, "ActiveDirectoryId": { "title": "String", "type": "string", "description": "Microsoft Entra tenant ID.", "minLength": 1 }, "Environment": { "description": "Azure environment.", "$ref": "#/components/schemas/AzureEnvironment" }, "ManagementEndpoint": { "title": "String", "type": "string", "description": "Azure management endpoint.", "minLength": 1 }, "AuthenticationAuthority": { "title": "String", "type": "string", "description": "Azure authentication authority.", "minLength": 1 } } } ] }, "HypervisorDetailAzureResponseModel": { "title": "HypervisorDetailAzureResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "ApplicationId", "SubscriptionId", "ActiveDirectoryId", "Environment", "ManagementEndpoint", "AuthenticationAuthority", "StorageSuffix" ], "properties": { "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure\nAPIs.", "minLength": 1 }, "SubscriptionId": { "title": "String", "type": "string", "description": "Azure subscription ID.", "minLength": 1 }, "ActiveDirectoryId": { "title": "String", "type": "string", "description": "Microsoft Entra tenant ID.", "minLength": 1 }, "Environment": { "description": "Azure environment.", "$ref": "#/components/schemas/AzureEnvironment" }, "ManagementEndpoint": { "title": "String", "type": "string", "description": "Azure management endpoint.", "minLength": 1 }, "AuthenticationAuthority": { "title": "String", "type": "string", "description": "Azure authentication authority.", "minLength": 1 }, "StorageSuffix": { "title": "String", "type": "string", "description": "Azure storage suffix.", "minLength": 1 } } } ] }, "HypervisorDetailGCPResponseModel": { "title": "HypervisorDetailGCPResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "ServiceAccountId" ], "properties": { "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Google Cloud APIs.", "minLength": 1 } } } ] }, "HypervisorDetailNutanixPCResponseModel": { "title": "HypervisorDetailNutanixPCResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailTraditionalResponseModel" }, { "type": "object", "description": "Hypervisor response object.", "additionalProperties": false } ] }, "HypervisorDetailOciResponseModel": { "title": "HypervisorDetailOciResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "TenancyOcid", "OciRegion", "ServiceAccountId", "OciEnvironment", "Fingerprint" ], "properties": { "TenancyOcid": { "title": "String", "type": "string", "description": "Oracle Cloud Infrastructure tenancy to connect to.\nRequired.", "minLength": 1 }, "OciRegion": { "title": "String", "type": "string", "description": "The region of Oracle Cloud Infrastructure.", "minLength": 1 }, "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Oracle Cloud Infrastructure APIs.", "minLength": 1 }, "OciEnvironment": { "title": "String", "type": "string", "description": "The environment of Oracle Cloud Infrastructure, Commercial or Government.", "minLength": 1 }, "Fingerprint": { "title": "String", "type": "string", "description": "The fingerprint of Oracle Cloud Infrastructure API key.", "minLength": 1 } } } ] }, "HypervisorDetailOpenShiftResponseModel": { "title": "HypervisorDetailOpenShiftResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "UserName" ], "properties": { "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL thumbprints considered acceptable for the SSL certificate\npresented by the hypervisor.", "nullable": true, "items": { "title": "String", "type": "string" } }, "UserName": { "title": "String", "type": "string", "description": "The username for the credentials used to communicate with the\nhypervisor.", "minLength": 1 } } } ] }, "HypervisorDetailOracleC3ResponseModel": { "title": "HypervisorDetailOracleC3ResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "TenancyOcid", "Region", "ServiceAccountId", "Fingerprint" ], "properties": { "TenancyOcid": { "title": "String", "type": "string", "description": "Oracle Compute Cloud@Customer tenancy to connect to.", "minLength": 1 }, "Region": { "title": "String", "type": "string", "description": "The region of Oracle Compute Cloud@Customer.", "minLength": 1 }, "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Oracle Compute Cloud@Customer APIs.", "minLength": 1 }, "Fingerprint": { "title": "String", "type": "string", "description": "The fingerprint of Oracle Compute Cloud@Customer API key.", "minLength": 1 }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL thumbprints considered acceptable for the SSL certificate\npresented by the hypervisor. Only applied for self-signed certificates.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "HypervisorDetailResponseModel": { "title": "HypervisorDetailResponseModel", "required": [ "ApiKey", "Region", "ApplicationId", "SubscriptionId", "ActiveDirectoryId", "Environment", "ManagementEndpoint", "AuthenticationAuthority", "StorageSuffix", "ServiceAccountId", "SccmWakeUpProxy", "WakeOnLanPackets", "UserName", "TenancyOcid", "OciRegion", "OciEnvironment", "Fingerprint" ], "properties": { "ApiKey": { "title": "String", "type": "string", "description": "The API key used to authenticate with the AWS APIs.", "minLength": 1 }, "Region": { "title": "String", "type": "string", "description": "The AWS region which the hypervisor represents.", "minLength": 1 }, "MaximumConcurrentProvisioningOperations": { "title": "Int32", "type": "integer", "description": "AWS maximum concurrent provisioning operations.", "format": "int32", "nullable": true }, "ApplicationId": { "title": "String", "type": "string", "description": "Application ID of the service principal used to access the Azure\nAPIs.", "minLength": 1 }, "SubscriptionId": { "title": "String", "type": "string", "description": "Azure subscription ID.", "minLength": 1 }, "ActiveDirectoryId": { "title": "String", "type": "string", "description": "Microsoft Entra tenant ID.", "minLength": 1 }, "Environment": { "description": "Azure environment.", "$ref": "#/components/schemas/AzureEnvironment" }, "ManagementEndpoint": { "title": "String", "type": "string", "description": "Azure management endpoint.", "minLength": 1 }, "AuthenticationAuthority": { "title": "String", "type": "string", "description": "Azure authentication authority.", "minLength": 1 }, "StorageSuffix": { "title": "String", "type": "string", "description": "Azure storage suffix.", "minLength": 1 }, "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Google Cloud APIs.", "minLength": 1 }, "SccmWakeUpProxy": { "title": "Boolean", "type": "boolean", "description": "Indicates whether Microsoft System Center Configuration Manager 2012\nSP1 Wake-up Proxy is used for power management." }, "WakeOnLanPackets": { "description": "Indicates the Wake on LAN packet transmission method to use for\npower management.", "$ref": "#/components/schemas/WakeOnLanTransmission" }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL thumbprints considered acceptable for the SSL certificate\npresented by the hypervisor.", "nullable": true, "items": { "title": "String", "type": "string" } }, "UserName": { "title": "String", "type": "string", "description": "The user name for the credentials used to communicate with the\nhypervisor.", "minLength": 1 }, "TenancyOcid": { "title": "String", "type": "string", "description": "Oracle Cloud Infrastructure tenancy to connect to.\nRequired.", "minLength": 1 }, "OciRegion": { "title": "String", "type": "string", "description": "The region of Oracle Cloud Infrastructure.", "minLength": 1 }, "OciEnvironment": { "title": "String", "type": "string", "description": "The environment of Oracle Cloud Infrastructure, Commercial or Government.", "minLength": 1 }, "Fingerprint": { "title": "String", "type": "string", "description": "The fingerprint of Oracle Cloud Infrastructure API key.", "minLength": 1 } }, "allOf": [ { "$ref": "#/components/schemas/HypervisorResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "Capabilities", "ConfigurationObjectCapabilities", "PluginRevision", "MaxAbsoluteActiveActions", "MaxAbsoluteNewActionsPerMinute", "MaxPowerActionsPercentageOfMachines", "ConnectionOptions", "SupportsLocalStorageCaching", "SupportsPvsVms", "ConnectionType" ], "properties": { "Capabilities": { "title": "String[]", "type": "array", "description": "List of capabilities supported by the hypervisor.", "items": { "title": "String", "type": "string" } }, "ConfigurationObjectCapabilities": { "title": "HypervisorConfigurationObjectCapability[]", "type": "array", "description": "List of configuration capabilities supported by each type of object\non the hypervisor.", "items": { "$ref": "#/components/schemas/HypervisorConfigurationObjectCapability" } }, "PluginRevision": { "title": "String", "type": "string", "description": "Revision of the plugin in use.", "minLength": 1 }, "MaxAbsoluteActiveActions": { "title": "Int32", "type": "integer", "description": "Maximum number of actions that can execute in parallel on the\nhypervisor.", "format": "int32" }, "MaxAbsoluteNewActionsPerMinute": { "title": "Int32", "type": "integer", "description": "Maximum number of actions that can be started on the hypervisor\nper-minute.", "format": "int32" }, "MaxPowerActionsPercentageOfMachines": { "title": "Int32", "type": "integer", "description": "Maximum percentage of machines on the hypervisor which can have\ntheir power state changed simultaneously.", "format": "int32" }, "ConnectionOptions": { "title": "String", "type": "string", "description": "Connection options to use for the hypervisor.", "minLength": 1 }, "SupportsLocalStorageCaching": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the hypervisor supports local storage caching." }, "SupportsPvsVms": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the hypervisor supports PVS VMs." }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata for hypervisor connections.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ConnectionType": { "description": "Type of hypervisor", "$ref": "#/components/schemas/HypervisorConnectionType" } } } ] }, "HypervisorDetailTraditionalResponseModel": { "title": "HypervisorDetailTraditionalResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "UserName" ], "properties": { "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL thumbprints considered acceptable for the SSL certificate\npresented by the hypervisor.", "nullable": true, "items": { "title": "String", "type": "string" } }, "UserName": { "title": "String", "type": "string", "description": "The user name for the credentials used to communicate with the\nhypervisor.", "minLength": 1 } } } ] }, "HypervisorDetailWOLResponseModel": { "title": "HypervisorDetailWOLResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorDetailTraditionalResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "SccmWakeUpProxy", "WakeOnLanPackets" ], "properties": { "SccmWakeUpProxy": { "title": "Boolean", "type": "boolean", "description": "Indicates whether Microsoft System Center Configuration Manager 2012\nSP1 Wake-up Proxy is used for power management." }, "WakeOnLanPackets": { "description": "Indicates the Wake on LAN packet transmission method to use for\npower management.", "$ref": "#/components/schemas/WakeOnLanTransmission" } } } ] }, "HypervisorFaultResponseModel": { "title": "HypervisorFaultResponseModel", "type": "object", "description": "Fault info for a hypervisor.", "additionalProperties": false, "properties": { "State": { "title": "String", "type": "string", "description": "Fault state associated with connection, or 'None' if OK.", "nullable": true }, "Reason": { "title": "String", "type": "string", "description": "Exception error text associated with any fault state.", "nullable": true }, "TimeEntered": { "title": "String", "type": "string", "description": "Time at which the hypervisor entered fault state", "nullable": true }, "DurationInSeconds": { "title": "Double", "type": "number", "description": "Period for which the hypervisor has been in fault state", "format": "double", "nullable": true } } }, "HypervisorGCPConnectionDetailRequestModel": { "title": "HypervisorGCPConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "ServiceAccountId", "ServiceAccountCredentials" ], "properties": { "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Google Cloud APIs.\nRequired.", "maxLength": 512, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountCredentials": { "title": "String", "type": "string", "description": "the JSON-encoded service account credentials used to access the\nGoogle Cloud APIs. Required. Must be specified in the format\nindicated by ServiceAccountCredentialsFormat.", "maxLength": 2147483647, "minLength": 1, "pattern": "((.|\\n)*)" }, "ServiceAccountCredentialsFormat": { "description": "Format of the ServiceAccountCredentials. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "CustomProperties": { "title": "String", "type": "string", "description": "The properties of host connection that are specific to the target hosting infrastructure.", "maxLength": 1024, "pattern": "((.|\\n)*)", "nullable": true } } } ] }, "HypervisorGpuTypeResourceResponseModel": { "title": "HypervisorGpuTypeResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "Enabled", "FrameBufferSizeMB", "HasDedicatedResource" ], "properties": { "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the GPU type is enabled on the hypervisor." }, "FrameBufferSizeMB": { "title": "Int32", "type": "integer", "description": "Frame Buffer Size in MB", "format": "int32" }, "HasDedicatedResource": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the GPU type has resources dedicated to it." } } } ] }, "HypervisorMachineCatalogResponseModel": { "title": "HypervisorMachineCatalogResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Name,FullName,Id,Uid,AllocationType,Description,IsPowerManaged,IsRemotePC,MachineType,MinimumFunctionalLevel,HasBeenPromoted,HasBeenPromotedFrom,PersistChanges,ProvisioningType,SessionSupport,SharingKind,Zone,AdminFolder,HypervisorVMTagging. \n Machine catalog related to a hypervisor or resource pool.\n ", "allOf": [ { "$ref": "#/components/schemas/MachineCatalogResponseModel" }, { "type": "object", "description": "Machine catalog related to a hypervisor or resource pool.", "additionalProperties": false, "properties": { "NumProvisionedMachines": { "title": "Int32", "type": "integer", "description": "Number of machines from the catalog that are provisioned on the hypervisor or resource pool.", "format": "int32" } } } ] }, "HypervisorMachineCatalogResponseModelCollection": { "title": "HypervisorMachineCatalogResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfHypervisorMachineCatalogResponseModel" }, { "type": "object", "description": "Machine catalog collection related to a hypervisor or resource pool.", "additionalProperties": false } ] }, "HypervisorNonCriticalIssueType": { "title": "HypervisorNonCriticalIssueType", "type": "string", "description": "Represents the type of non-critical issue that can occur on a hypervisor.", "x-enumNames": [ "Unknown", "UnsupportedPlugin", "InFaultState", "SecretMissing", "SecretExpiring", "PermissionNotGrantedForAadDeviceManagement", "Unentitled" ], "enum": [ "Unknown", "UnsupportedPlugin", "InFaultState", "SecretMissing", "SecretExpiring", "PermissionNotGrantedForAadDeviceManagement", "Unentitled" ] }, "HypervisorNutanixPCConnectionDetailRequestModel": { "title": "HypervisorNutanixPCConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorTraditionalConnectionDetailRequestModel" }, { "type": "object", "description": "Hypervisor connection details for nutanix pc hypervisors.", "additionalProperties": false } ] }, "HypervisorOciConnectionDetailRequestModel": { "title": "HypervisorOciConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "TenancyOcid", "Region", "ServiceAccountId", "ServiceAccountCredential", "ServiceAccountFingerprint" ], "properties": { "TenancyOcid": { "title": "String", "type": "string", "description": "Oracle Cloud Infrastructure tenancy to connect to.\nRequired.", "maxLength": 128, "minLength": 1, "pattern": "(.*)*" }, "Region": { "title": "String", "type": "string", "description": "Oracle Cloud Infrastructure region to connect to.\nRequired.", "maxLength": 32, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Oracle Cloud Infrastructure APIs.\nRequired.", "maxLength": 128, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountCredential": { "title": "String", "type": "string", "description": "The private key string to access the Oracle Cloud Infrastructure APIs.\nRequired. Must be specified in the format\nindicated by ServiceAccountCredentialFormat.", "maxLength": 2147483647, "minLength": 1, "pattern": "((.|\\n)*)" }, "ServiceAccountCredentialFormat": { "description": "Format of the ServiceAccountCredential. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "ServiceAccountFingerprint": { "title": "String", "type": "string", "description": "The fingerprint of the public key associate with the ServiceAccountCredential.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "OciEnvironment": { "description": "OCI environment. Optional. Default is\nCommercial.", "default": "Commercial", "nullable": true, "$ref": "#/components/schemas/OciEnvironment" } } } ] }, "HypervisorOpenShiftConnectionDetailRequestModel": { "title": "HypervisorOpenShiftConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "UserName", "Password", "Addresses" ], "properties": { "UserName": { "title": "String", "type": "string", "description": "Hypervisor username. Required.", "maxLength": 256, "minLength": 1, "pattern": "(.*)*" }, "Password": { "title": "String", "type": "string", "description": "Hypervisor password. Required. Must be specified in the format\nindicated by PasswordFormat.", "maxLength": 20480, "minLength": 1, "pattern": "(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*]).{8,}|^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|(.*)*" }, "PasswordFormat": { "description": "Format of the Password. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Addresses": { "title": "String[]", "type": "array", "description": "Hypervisor address(es). At least one is required.", "items": { "title": "String", "type": "string" } }, "PluginId": { "title": "String", "type": "string", "description": "Custom hypervisor plugin ID. Required if the\nConnectionType is\nCustom. Otherwise must not\nbe specified.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL certificate thumbprints to consider acceptable for this\nconnection. Optional. If not specified, and the hypervisor uses\nSSL for its connection, the SSL certificate's root certification\nauthority and any intermediate certificates must be trusted.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "HypervisorOracleC3ConnectionDetailRequestModel": { "title": "HypervisorOracleC3ConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "TenancyOcid", "Region", "ServiceAccountId", "ServiceAccountCredential", "ServiceAccountFingerprint" ], "properties": { "TenancyOcid": { "title": "String", "type": "string", "description": "Oracle Compute Cloud@Customer tenancy to connect to.\nRequired.", "maxLength": 128, "minLength": 1, "pattern": "(.*)*" }, "Region": { "title": "String", "type": "string", "description": "Oracle Compute Cloud@Customer region to connect to.\nRequired.", "maxLength": 32, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountId": { "title": "String", "type": "string", "description": "The service account ID used to access the Oracle Compute Cloud@Customer APIs.\nRequired.", "maxLength": 128, "minLength": 1, "pattern": "(.*)*" }, "ServiceAccountCredential": { "title": "String", "type": "string", "description": "The private key string to access the Oracle Compute Cloud@Customer APIs.\nRequired. Must be specified in the format\nindicated by ServiceAccountCredentialFormat.", "maxLength": 2147483647, "minLength": 1, "pattern": "((.|\\n)*)" }, "ServiceAccountCredentialFormat": { "description": "Format of the ServiceAccountCredential. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "ServiceAccountFingerprint": { "title": "String", "type": "string", "description": "The fingerprint of the public key associate with the ServiceAccountCredential.", "maxLength": 64, "minLength": 1, "pattern": "(.*)*" }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL certificate thumbprints to consider acceptable for this\nconnection. Optional. If not specified, and the hypervisor uses\nSSL for its connection, the SSL certificate's root certification\nauthority and any intermediate certificates must be trusted.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "HypervisorPluginResponseModel": { "title": "HypervisorPluginResponseModel", "type": "object", "description": "Hypervisor plugin response model.", "additionalProperties": false, "properties": { "ConnectionType": { "description": "The Hypervisor connection type.", "$ref": "#/components/schemas/HypervisorConnectionType" }, "DisplayName": { "title": "String", "type": "string", "description": "Hypervisor display name.", "nullable": true }, "PluginFactoryName": { "title": "String", "type": "string", "description": "Plugin factory name.", "nullable": true }, "UsesCloudInfrastructure": { "title": "Boolean", "type": "boolean", "description": "If use Cloud Infrastructure." }, "Environments": { "title": "HypervisorAzureEnvironmentResponseModel[]", "type": "array", "description": "This property only used when ConnectionType is AzureRM\nThis property provides all supported Azure environments.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorAzureEnvironmentResponseModel" } }, "CitrixVerified": { "title": "Boolean", "type": "boolean", "description": "If the plugin is verified by Citrix.", "nullable": true }, "Available": { "title": "Boolean", "type": "boolean", "description": "Is the hypervisor plugin available or not.", "nullable": true }, "UnavailableReason": { "title": "String", "type": "string", "description": "The reason why the hypervisor is unavailable now", "nullable": true } } }, "HypervisorPluginResponseModelCollection": { "title": "HypervisorPluginResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfHypervisorPluginResponseModel" }, { "type": "object", "additionalProperties": false } ] }, "HypervisorRefResponseModel": { "title": "HypervisorRefResponseModel", "allOf": [ { "$ref": "#/components/schemas/RefResponseModel" }, { "type": "object", "description": "Reference to a hypervisor. To dereference and access the details\nabout the resource pool, use\nGetHypervisor\nwith Id and\nId path parameters.", "additionalProperties": false, "properties": { "ConnectionType": { "description": "Type of hypervisor.", "$ref": "#/components/schemas/HypervisorConnectionType" }, "PluginFactoryName": { "title": "String", "type": "string", "description": "The class name for the Citrix Managed Machine library that is used to access\nthe hypervisor.", "nullable": true } } } ] }, "HypervisorResourcePoolAWCDetailResponseModel": { "title": "HypervisorResourcePoolAWCDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "VirtualPrivateCloud", "AvailabilityZone", "Networks" ], "properties": { "VirtualPrivateCloud": { "description": "Amazon WorkSpaces Core Virtual Private Cloud (VPC) which the resource pool is connected\nto.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "AvailabilityZone": { "description": "Availability zone.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Networks": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of networks that may be used within the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } } } } ] }, "HypervisorResourcePoolAWSDetailResponseModel": { "title": "HypervisorResourcePoolAWSDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "VirtualPrivateCloud", "AvailabilityZone", "Networks" ], "properties": { "VirtualPrivateCloud": { "description": "AWS Virtual Private Cloud (VPC) which the resource pool is connected\nto.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "AvailabilityZone": { "description": "Availability zone.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Networks": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of networks that may be used within the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } } } } ] }, "HypervisorResourcePoolAzureDetailResponseModel": { "title": "HypervisorResourcePoolAzureDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "Region", "VirtualNetwork", "Subnets" ], "properties": { "Region": { "description": "Azure region which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "VirtualNetwork": { "description": "Azure virtual network which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Subnets": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of subnets in the VirtualNetwork that may be used\nwithin the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } } } } ] }, "HypervisorResourcePoolDetailResponseModel": { "title": "HypervisorResourcePoolDetailResponseModel", "required": [ "VirtualPrivateCloud", "AvailabilityZone", "Networks", "Region", "VirtualNetwork", "Subnets", "Project", "Storage", "TemporaryStorage" ], "properties": { "VirtualPrivateCloud": { "description": "AWS Virtual Private Cloud (VPC) which the resource pool is connected\nto.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "AvailabilityZone": { "description": "Availability zone.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Networks": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of networks that may be used within the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } }, "Region": { "description": "Azure region which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "VirtualNetwork": { "description": "Azure virtual network which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Subnets": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of subnets in the VirtualNetwork that may be used\nwithin the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } }, "Project": { "description": "Google Cloud Platform project which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "RootPath": { "description": "Root resource path, within the full set of hypervisor resources, in\nwhich the resource pool resides.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Storage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for OS disks of virtual machines.", "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "TemporaryStorage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for temporary data storage for virtual machines.", "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "UseLocalStorageCaching": { "title": "Boolean", "type": "boolean", "description": "Indicates whether virtual machines created within this resource pool\nwill use local storage caching for their disk images.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "nullable": true }, "PersonalvDiskStorage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for personal v disk data storage for virtual machines.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "StorageBalanceType": { "description": "Storage Balance Type. Only used for hypervisors of type\nXenServer.\nSCVMM.\nVCenter.", "nullable": true, "$ref": "#/components/schemas/StorageBalanceType" } }, "allOf": [ { "$ref": "#/components/schemas/HypervisorResourcePoolResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "ConnectionType" ], "properties": { "GpuTypes": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "GPU types available in the resource pool. Only applicable to\nhypervisors that support GPU types.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } }, "ConnectionType": { "description": "Type of hypervisor", "$ref": "#/components/schemas/HypervisorConnectionType" }, "UsesExplicitStorage": { "title": "Boolean", "type": "boolean", "description": "If the hypervisor resource pool use ExplicitStorage." }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata for hypervisor resource pool. ", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ContainerScopes": { "title": "ContainerScopeResponseModel[]", "type": "array", "description": "Delegated admin scopes in which the containers of the\nresource pool reside.", "nullable": true, "items": { "$ref": "#/components/schemas/ContainerScopeResponseModel" } } } } ] }, "HypervisorResourcePoolGcpDetailResponseModel": { "title": "HypervisorResourcePoolGcpDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "Project", "Region", "VirtualPrivateCloud", "Networks" ], "properties": { "Project": { "description": "Google Cloud Platform project which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Region": { "description": "Google Cloud Platform region which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "VirtualPrivateCloud": { "description": "Google Cloud Platform virtual network which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Networks": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of networks in the VirtualPrivateCloud that may be used\nwithin the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } } } } ] }, "HypervisorResourcePoolNetworkResponseModel": { "title": "HypervisorResourcePoolNetworkResponseModel", "type": "object", "description": "Available network collection response item.", "additionalProperties": false, "properties": { "ConnectionName": { "title": "String", "type": "string", "description": "Hypervisor connection name.", "nullable": true }, "ConnectionId": { "title": "String", "type": "string", "description": "Hypervisor connection id.", "nullable": true }, "ResourcePoolName": { "title": "String", "type": "string", "description": "Resource pool name.", "nullable": true }, "ResourcePoolId": { "title": "String", "type": "string", "description": "Resource pool Id.", "nullable": true }, "NetworkName": { "title": "String", "type": "string", "description": "Network name.", "nullable": true }, "NetworkId": { "title": "String", "type": "string", "description": "Network id.", "nullable": true }, "NetworkPath": { "title": "String", "type": "string", "description": "Network inventory XDHyp path.", "nullable": true } } }, "HypervisorResourcePoolNetworkResponseModelCollection": { "title": "HypervisorResourcePoolNetworkResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfHypervisorResourcePoolNetworkResponseModel" }, { "type": "object", "additionalProperties": false } ] }, "HypervisorResourcePoolNutanixPCDetailResponseModel": { "title": "HypervisorResourcePoolNutanixPCDetailResponseModel", "required": [ "VirtualPrivateCloud", "AvailabilityZone", "Networks", "Region", "VirtualNetwork", "Subnets", "Project", "Storage", "TemporaryStorage", "ConnectionType" ], "properties": { "VirtualPrivateCloud": { "description": "AWS Virtual Private Cloud (VPC) which the resource pool is connected\nto.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "AvailabilityZone": { "description": "Availability zone.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Networks": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of networks that may be used within the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } }, "Region": { "description": "Azure region which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "VirtualNetwork": { "description": "Azure virtual network which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Subnets": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of subnets in the VirtualNetwork that may be used\nwithin the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } }, "Project": { "description": "Google Cloud Platform project which the resource pool is connected to.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "RootPath": { "description": "Root resource path, within the full set of hypervisor resources, in\nwhich the resource pool resides.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Storage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for OS disks of virtual machines.", "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "TemporaryStorage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for temporary data storage for virtual machines.", "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "UseLocalStorageCaching": { "title": "Boolean", "type": "boolean", "description": "Indicates whether virtual machines created within this resource pool\nwill use local storage caching for their disk images.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "nullable": true }, "PersonalvDiskStorage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for personal v disk data storage for virtual machines.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "StorageBalanceType": { "description": "Storage Balance Type. Only used for hypervisors of type\nXenServer.\nSCVMM.\nVCenter.", "nullable": true, "$ref": "#/components/schemas/StorageBalanceType" }, "GpuTypes": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "GPU types available in the resource pool. Only applicable to\nhypervisors that support GPU types.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } }, "ConnectionType": { "description": "Type of hypervisor", "$ref": "#/components/schemas/HypervisorConnectionType" }, "UsesExplicitStorage": { "title": "Boolean", "type": "boolean", "description": "If the hypervisor resource pool use ExplicitStorage." }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata for hypervisor resource pool. ", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ContainerScopes": { "title": "ContainerScopeResponseModel[]", "type": "array", "description": "Delegated admin scopes in which the containers of the\nresource pool reside.", "nullable": true, "items": { "$ref": "#/components/schemas/ContainerScopeResponseModel" } } }, "allOf": [ { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" }, { "type": "object", "description": "Pool of resources available on Nutanix PC hypervisor.", "additionalProperties": false } ] }, "HypervisorResourcePoolPatchPreviewRequestModel": { "title": "HypervisorResourcePoolPatchPreviewRequestModel", "type": "object", "additionalProperties": false, "properties": { "Networks": { "title": "String[]", "type": "array", "description": "Path to the networks/subnets that are available for provisioning operations\nin this resource pool. At least one is required.", "nullable": true, "items": { "title": "String", "type": "string" } }, "NetworkIds": { "title": "String[]", "type": "array", "description": "Ids of the networks/subnets that are available for provisioning operations, at least one is required.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "HypervisorResourcePoolPatchPreviewResponseModel": { "title": "HypervisorResourcePoolPatchPreviewResponseModel", "type": "object", "description": "Hypervisor Resource Pool Patch Preview response model.", "additionalProperties": false, "properties": { "NetworksCanBeDeleted": { "title": "String[]", "type": "array", "description": "These networks are not referenced and can be deleted normally.", "nullable": true, "items": { "title": "String", "type": "string" } }, "NetworksToBeDeleted": { "title": "String[]", "type": "array", "description": "After comparing with the present hosting unit, these networks should be deleted.", "nullable": true, "items": { "title": "String", "type": "string" } }, "DeleteImpactedCatalogs": { "title": "Dictionary`2", "type": "object", "description": "Details of the referenced network and catalogs.", "nullable": true, "additionalProperties": { "title": "Dictionary`2", "type": "object", "additionalProperties": { "title": "Int32", "type": "integer", "format": "int32" } } } } }, "HypervisorResourcePoolRefResponseModel": { "title": "HypervisorResourcePoolRefResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorBaseResponseModel" }, { "type": "object", "description": "Reference to a hypervisor resource pool, AKA \"HostingUnit\". To\ndereference and access the details about the resource pool, use\nGetHypervisorResourcePool\nwith Hypervisor.Id\nand Id path parameters.", "additionalProperties": false, "required": [ "FullRelativePath", "Hypervisor" ], "properties": { "FullRelativePath": { "title": "String", "type": "string", "description": "Full path to the resources within the resource pool, including the hypervisor, relative to\nthe root of the API.\nExample: `Hypervisors/{{hypervisor id}}/ResourcePools/{{resource pool id}}/Resources`", "minLength": 1 }, "Hypervisor": { "description": "Hypervisor on which the resource pool resides.", "$ref": "#/components/schemas/HypervisorRefResponseModel" } } } ] }, "HypervisorResourcePoolResponseModel": { "title": "HypervisorResourcePoolResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorBaseResponseModel" }, { "type": "object", "description": "Pool of resources available on a hypervisor.", "additionalProperties": false, "required": [ "HypervisorConnection", "ConnectionType", "DefaultNetwork", "VMTaggingEnabled" ], "properties": { "HypervisorConnection": { "description": "The hypervisor connection associated with this resource pool.", "$ref": "#/components/schemas/RefResponseModel" }, "ConnectionType": { "description": "Type of hypervisor", "$ref": "#/components/schemas/HypervisorConnectionType" }, "DefaultNetwork": { "description": "Default network to use for VMs provisioned using the resource pool.", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "VMTaggingEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether new virtual machines are tagged with metadata from\nthe hypervisor." }, "ResourcePoolRootPath": { "title": "String", "type": "string", "description": "Hypervisor resourcePool RootPath.", "nullable": true }, "ResourcePoolRootId": { "title": "String", "type": "string", "description": "Hypervisor resourcePool RootId.", "nullable": true } } } ] }, "HypervisorResourcePoolResponseModelCollection": { "title": "HypervisorResourcePoolResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfHypervisorResourcePoolDetailResponseModel" }, { "type": "object", "additionalProperties": false } ] }, "HypervisorResourcePoolStorageRequestModel": { "title": "HypervisorResourcePoolStorageRequestModel", "type": "object", "description": "Request model for specifying resource pool storage.", "additionalProperties": false, "required": [ "StoragePath" ], "properties": { "StoragePath": { "title": "String", "type": "string", "description": "Path to storage within the resource pool. Required.", "minLength": 1 }, "Superseded": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the storage has been superseded. Superseded\nstorage may be used for existing virtual machines, but is not used\nwhen provisioning new virtual machines. Optional; default is\n`false`.", "default": false, "nullable": true } } }, "HypervisorResourcePoolTestResponseModel": { "title": "HypervisorResourcePoolTestResponseModel", "type": "object", "description": "Response object for a resource pool test result.", "additionalProperties": false, "required": [ "ResourcePool", "NumPassed", "NumWarnings", "NumFailures" ], "properties": { "ResourcePool": { "description": "The resource pool upon which the test was run.", "$ref": "#/components/schemas/RefResponseModel" }, "NumPassed": { "title": "Int32", "type": "integer", "description": "The number of tests that passed.", "format": "int32" }, "NumWarnings": { "title": "Int32", "type": "integer", "description": "The number of warnings that were found.", "format": "int32" }, "NumFailures": { "title": "Int32", "type": "integer", "description": "The number of tests that failed.", "format": "int32" }, "TestReport": { "description": "The detailed test report, only included when specifically requested in the API call.", "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } }, "HypervisorResourcePoolTraditionalDetailResponseModel": { "title": "HypervisorResourcePoolTraditionalDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourcePoolDetailResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "Networks", "Storage", "TemporaryStorage" ], "properties": { "RootPath": { "description": "Root resource path, within the full set of hypervisor resources, in\nwhich the resource pool resides.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Networks": { "title": "HypervisorResourceRefResponseModel[]", "type": "array", "description": "List of networks that are allowed to be used within the resource pool.", "items": { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" } }, "Storage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for OS disks of virtual machines.", "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "TemporaryStorage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for temporary data storage for virtual machines.", "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "UseLocalStorageCaching": { "title": "Boolean", "type": "boolean", "description": "Indicates whether virtual machines created within this resource pool\nwill use local storage caching for their disk images.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "Custom properties. Optional. If not specified, will not be\nchanged. Only used for hypervisors of type\nCustom.", "nullable": true }, "PersonalvDiskStorage": { "title": "HypervisorStorageResourceResponseModel[]", "type": "array", "description": "List of hypervisor-connected storage in the resource pool that is\nused for personal v disk data storage for virtual machines.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorStorageResourceResponseModel" } }, "StorageBalanceType": { "description": "Storage Balance Type. Only used for hypervisors of type\nXenServer.\nSCVMM.\nVCenter.", "nullable": true, "$ref": "#/components/schemas/StorageBalanceType" } } } ] }, "HypervisorResourcePricesResponseModel": { "title": "HypervisorResourcePricesResponseModel", "type": "object", "description": "Response model for the pricing information of different hypervisor resource settings.", "additionalProperties": false, "properties": { "VmPrices": { "title": "VmPriceResponseModel[]", "type": "array", "description": "The pricing information for the virtual machines settings.", "nullable": true, "items": { "$ref": "#/components/schemas/VmPriceResponseModel" } }, "DiskPrices": { "title": "DiskPriceResponseModel[]", "type": "array", "description": "The pricing information for the disk settings.", "nullable": true, "items": { "$ref": "#/components/schemas/DiskPriceResponseModel" } }, "WarningMessage": { "title": "String", "type": "string", "description": "The warning message.", "nullable": true } } }, "HypervisorResourceRefResponseModel": { "title": "HypervisorResourceRefResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorBaseResponseModel" }, { "type": "object", "description": "Hypervisor resource reference.", "additionalProperties": false, "properties": { "RelativePath": { "title": "String", "type": "string", "description": "Path to the object, relative to the resource pool from which\nit was queried.\n`{{vm name}}.vm/{{snapshot name}}.snapshot`", "nullable": true }, "FullRelativePath": { "title": "String", "type": "string", "description": "Full path to the resource, including the hypervisor, relative to\nthe root of the API.\nExample: `Hypervisors/{{hypervisor id}}/ResourcePools/{{resource pool id}}/Resources/{{RelativePath}}`", "nullable": true }, "ResourceType": { "title": "String", "type": "string", "description": "Type of resource.", "nullable": true }, "ObjectTypeName": { "title": "String", "type": "string", "description": "The type name of the hypervisor resource object.", "nullable": true }, "ResourceContainer": { "description": "Container in which the resource resides.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "ResourcePoolXDPath": { "title": "String", "type": "string", "description": "Citrix Apps and Desktops path to the resource\non the ResourcePool. An example value is:\n`XDHyp:\\HostingUnits\\{{resource pool name}}\\{{resource name}}.{{resource type}}`\nThis value", "nullable": true } } } ] }, "HypervisorResourceResponseModel": { "title": "HypervisorResourceResponseModel", "required": [ "SupportsSecurityGroups", "Enabled", "FrameBufferSizeMB", "HasDedicatedResource", "EgressRules", "IngressRules", "MemorySizeMB", "NumberOfCores", "OptimizedForPooledDesktops", "NetworkPerformanceIsUnlimited", "NetworkPerformanceIsDefault", "IsUsedInSite", "Superseded", "HasPersistentRootVolume", "VMId", "InstanceSecurityGroupLimit" ], "properties": { "SupportsSecurityGroups": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this zone supports the use of security groups for isolation." }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the GPU type is enabled on the hypervisor." }, "FrameBufferSizeMB": { "title": "Int32", "type": "integer", "description": "Frame Buffer Size in MB", "format": "int32" }, "HasDedicatedResource": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the GPU type has resources dedicated to it." }, "Description": { "title": "String", "type": "string", "description": "Description of the security group.", "nullable": true }, "EgressRules": { "title": "HypervisorSecurityGroupRuleResponseModel[]", "type": "array", "description": "Egress rules governing outbound network traffic.", "items": { "$ref": "#/components/schemas/HypervisorSecurityGroupRuleResponseModel" } }, "IngressRules": { "title": "HypervisorSecurityGroupRuleResponseModel[]", "type": "array", "description": "Ingress rules governing inbound network traffic.", "items": { "$ref": "#/components/schemas/HypervisorSecurityGroupRuleResponseModel" } }, "VirtualPrivateCloudId": { "title": "String", "type": "string", "description": "The identifier of the associated VPC.", "nullable": true }, "DedicatedTenancy": { "title": "String", "type": "string", "description": "Indicates whether this service offering prescribes dedicated tenancy for the instances\nthat use it.", "nullable": true }, "MemorySizeMB": { "title": "Decimal", "type": "number", "description": "The amount of memory that is available to instances using this service offering, measured in megabytes.", "format": "decimal" }, "NumberOfCores": { "title": "Decimal", "type": "number", "description": "The number of virtual cores that are available to instances using this service offering.", "format": "decimal" }, "AmazonComputeUnits": { "title": "Decimal", "type": "number", "description": "The number of Amazon EC2 compute units that are available to instances using this service offering. This\nproperty is only meaningful for EC2-based cloud connections.", "format": "decimal", "nullable": true }, "OptimizedForPooledDesktops": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this service offering is intended specifically for usage with pooled\ndesktops." }, "NetworkPerformance": { "title": "String", "type": "string", "description": "The network performance available to instances using this service offering.", "nullable": true }, "NetworkPerformanceIsUnlimited": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this service offering has no limit for it's network rate." }, "NetworkPerformanceIsDefault": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this service offering has a default limit for it's network rate." }, "IsUsedInSite": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the service offering is used by any machine catalogs in the site." }, "SupportsAzurePremiumStorage": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the service offering supports premium storage.\nThis property is only meaningful on Azure.", "nullable": true }, "Superseded": { "title": "Boolean", "type": "boolean", "description": "Indicates whether storage has been superseded. Superseded storage\nmay be used for existing virtual machines, but is not used when\nprovisioning new virtual machines." }, "Owner": { "title": "String", "type": "string", "description": "The account ID for the owner of this template.", "nullable": true }, "IsWindowsTemplate": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this is a Windows OS template, if known.", "nullable": true }, "HasPersistentRootVolume": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this template has a persistent root volume (eg. is an EBS-backed image\non AWS)." }, "VMId": { "title": "String", "type": "string", "description": "Id of the VM, as defined by the hypervisor.", "minLength": 1 }, "MacAddress": { "title": "String", "type": "string", "description": "MAC address of the VM.", "nullable": true }, "CpuCount": { "title": "Int32", "type": "integer", "description": "Number of CPUs, if known.", "format": "int32", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "Memory in megabytes, if known.", "format": "int32", "nullable": true }, "HardDiskSizeGB": { "title": "Int32", "type": "integer", "description": "Hard disk size in gigabytes, if known.", "format": "int32", "nullable": true }, "MinMemoryMB": { "title": "Int32", "type": "integer", "description": "Minimum memory required to run this VM or snapshot, in megabytes, if known.", "format": "int32", "nullable": true }, "NetworkMappings": { "title": "NetworkMapResponseModel[]", "type": "array", "description": "Network mappings associated with the VM, if known.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapResponseModel" } }, "AttachedDisks": { "title": "AttachedDiskResponseModel[]", "type": "array", "description": "Disks attached to the VM, if known.", "nullable": true, "items": { "$ref": "#/components/schemas/AttachedDiskResponseModel" } }, "InstanceSecurityGroupLimit": { "title": "Int32", "type": "integer", "description": "Indicates the maximum number of security groups allowed per instance in this VPC", "format": "int32" }, "Endpoint": { "title": "String", "type": "string", "description": "The API address with the region.", "nullable": true } }, "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "FullName", "IsContainer", "IsMachine", "IsSnapshotable", "AllResourcesRelativePath", "ResourcePool", "IsSymLink", "ResourceType" ], "properties": { "FullName": { "title": "String", "type": "string", "description": "Name of the resource, with the type concatenated.\ni.e. \"name.type\".", "minLength": 1 }, "IsContainer": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the resource is a container." }, "Children": { "title": "HypervisorResourceResponseModel[]", "type": "array", "description": "Child resources, when the resource is a container.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourceResponseModel" } }, "IsMachine": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the resource is a machine." }, "IsSnapshotable": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the resource can have a snapshot taken." }, "AllResourcesRelativePath": { "title": "String", "type": "string", "description": "Path to the resource, relative to the special \"AllResources\"\nresource pool associated with the hypervisor.", "minLength": 1 }, "ResourcePool": { "description": "Resource pool from which this resource was queried.", "$ref": "#/components/schemas/HypervisorResourcePoolRefResponseModel" }, "IsSymLink": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the object is a valid symbolic link." }, "AdditionalData": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Additional data about the object in the form of key-value pairs.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ResourceType": { "title": "String", "type": "string", "description": "Type of resource.", "minLength": 1 } } } ] }, "HypervisorResourceResponseModelCollection": { "title": "HypervisorResourceResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfHypervisorResourceResponseModel" }, { "type": "object", "description": "Hypervisor resource response model Collection model.", "additionalProperties": false } ] }, "HypervisorResourceSearchRequestModel": { "title": "HypervisorResourceSearchRequestModel", "type": "object", "description": "Request model for hypervisor resource search criteria.", "additionalProperties": false, "properties": { "Path": { "title": "String", "type": "string", "description": "The path to retrieve contents from.", "nullable": true }, "ResourceType": { "description": "The type of resources to get. Mutually exclusive with ResourceTypes.\nFor AWS, only 'Template', 'Vm' and 'LaunchTemplateVersion' are supported.\nFor Azure, only 'Snapshot', 'ManagedDisk', 'ImageDefinition', 'Vm' and 'TemplateSpec' are supported.\nFor VMWare, only 'Folder' is supported.\nFor Nutanix, only 'Template' and 'Vm' are supported.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceSearchResourceType" }, "ResourceTypes": { "title": "HypervisorResourceSearchResourceType[]", "type": "array", "description": "The type list of resources to get. Mutually exclusive with ResourceType.\nAll supported types are the same as ResourceType", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorResourceSearchResourceType" } }, "Template": { "title": "String", "type": "string", "description": "Used for the Machine Profile ResourceTypes only.\nIt specifies a Template identifier or name to use in validation of the Machine Profile with the given Template.\nThe validation will pass if the given Machine Profile resource is compatible with the given Template.\nOnly Machine Profiles which pass this validation are included.", "nullable": true }, "ForwardDirection": { "title": "Boolean", "type": "boolean", "description": "True if returning items which begin at the ContinuationToken, false if ending at the ContinuationToken.", "nullable": true }, "NameContains": { "title": "String", "type": "string", "description": "Only return items which contain this string in their Name.", "nullable": true }, "Tags": { "title": "NameValueStringPairModel[]", "type": "array", "description": "A list of key-value pairs, searching by a tag lets you filter the resources by a tag key or a tag value(value is optional).\nFor example: [{\"Name\": \"Priority\", \"Value\": \"high\"}, {\"Name\": \"Name\", \"Value\": \"test\"}, {\"Name\": \"TestMachine\", \"Value\": \"\"}, {\"Name\": \"ADBackup\", \"Value\": \"Not tagged\"}]", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "AdditionalData": { "title": "NameValueStringPairModel[]", "type": "array", "description": "A list of key-value pairs, filtering resources based on the AdditionalData properties.\nAll values given must match for an item to be included.\nFor example: [{\"Name\": \"HibernationSupported\", \"Value\": \"True\"}]", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Id": { "title": "String", "type": "string", "description": "Only return the item with the matching Id.", "nullable": true } } }, "HypervisorResourceSearchResourceType": { "title": "HypervisorResourceSearchResourceType", "type": "string", "description": "Supported resource type for HypervisorResourceSearchRequestModel.ResourceType.", "x-enumNames": [ "Template", "Vm", "LaunchTemplateVersion", "Folder", "Snapshot", "ManagedDisk", "Gallery", "ImageDefinition", "TemplateSpec", "Tag", "ResourceGroup", "SecurityGroup", "AvailabilityZone", "Network", "ServiceOffering", "VirtualPrivateCloud", "Info", "LaunchTemplate" ], "enum": [ "Template", "Vm", "LaunchTemplateVersion", "Folder", "Snapshot", "ManagedDisk", "Gallery", "ImageDefinition", "TemplateSpec", "Tag", "ResourceGroup", "SecurityGroup", "AvailabilityZone", "Network", "ServiceOffering", "VirtualPrivateCloud", "Info", "LaunchTemplate" ] }, "HypervisorResourceSettingsRequestModel": { "title": "HypervisorResourceSettingsRequestModel", "type": "object", "description": "Request object allowing caller to specify\nthe settings of different hypervisor resources.", "additionalProperties": false, "properties": { "VmSettings": { "title": "VmSettingRequestModel[]", "type": "array", "description": "The settings for the virtual machines.", "nullable": true, "items": { "$ref": "#/components/schemas/VmSettingRequestModel" } }, "DiskSettings": { "title": "DiskSettingRequestModel[]", "type": "array", "description": "The settings for the disks.", "nullable": true, "items": { "$ref": "#/components/schemas/DiskSettingRequestModel" } } } }, "HypervisorResourceValidationRequestModel": { "title": "HypervisorResourceValidationRequestModel", "type": "object", "description": "The resource validation request.", "additionalProperties": false, "required": [ "Path" ], "properties": { "Path": { "title": "String", "type": "string", "description": "Relative path of a resource", "minLength": 1 } } }, "HypervisorResourceValidationResponseModel": { "title": "HypervisorResourceValidationResponseModel", "type": "object", "description": "The resource validation response.", "additionalProperties": false, "properties": { "ResourceRef": { "description": "The resource reference. Only the attibute FullRelativePath\nis populated in response.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "Reports": { "title": "ResourceValidationReportModel[]", "type": "array", "description": "The validation reports.", "nullable": true, "items": { "$ref": "#/components/schemas/ResourceValidationReportModel" } } } }, "HypervisorResponseModel": { "title": "HypervisorResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorBaseResponseModel" }, { "type": "object", "description": "Response object for a hypervisor.", "additionalProperties": false, "required": [ "ConnectionType", "Addresses", "InMaintenanceMode", "PluginId", "Scopes", "UsesCloudInfrastructure", "Zone" ], "properties": { "ConnectionType": { "description": "Type of hypervisor", "$ref": "#/components/schemas/HypervisorConnectionType" }, "Addresses": { "title": "String[]", "type": "array", "description": "Addresses that can be used to contact the required hypervisor. All the\naddresses are considered equivalent, that is, all of the addresses\nprovide access to the same virtual machines, snapshots, network, and\nstorage.", "items": { "title": "String", "type": "string" } }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the hypervisor is in maintenance mode, which disables\nall communication between XenApp & XenDesktop and the Hypervisor." }, "Unentitled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether is UnEntitled." }, "PluginId": { "title": "String", "type": "string", "description": "The class name for the Citrix Managed Machine library that is used to access\nthe hypervisor.", "minLength": 1 }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "The list of administrative scopes that the connection is a part of.\nThe scopes control which administrators are able to work with the\nconnection.", "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "Tenants": { "title": "RefResponseModel[]", "type": "array", "description": "The tenant(s) that the hypervisor is assigned to. If `null`, the\nhypervisor is not assigned to tenants, and may be used by any\ntenant, including future added tenants.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "UsesCloudInfrastructure": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the hypervisor uses cloud infrastructure." }, "Zone": { "description": "Zone which the hypervisor is associated with.", "$ref": "#/components/schemas/RefResponseModel" }, "Fault": { "description": "Hypervisor fault state info.", "nullable": true, "$ref": "#/components/schemas/HypervisorFaultResponseModel" }, "CustomProperties": { "title": "String", "type": "string", "description": "CustomProperties of hypervisor connection", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "The broker id.", "format": "int32", "nullable": true }, "IsVirtual": { "title": "Boolean", "type": "boolean", "description": "If this connection is virtual." }, "CriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "List of critical issues that are present on the hypervisor.", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfHypervisorCriticalIssueType" } }, "NonCriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "List of non-critical issues that are present on the hypervisor.", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfHypervisorNonCriticalIssueType" } } } } ] }, "HypervisorResponseModelCollection": { "title": "HypervisorResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfHypervisorResponseModel" }, { "type": "object", "additionalProperties": false } ] }, "HypervisorsAndResourcePoolsResponseModel": { "title": "HypervisorsAndResourcePoolsResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResponseModel" }, { "type": "object", "description": "Reference to a HypervisorResponseModel info.\nThis class is designed for the UI main view.", "additionalProperties": false, "required": [ "DisplayConnectionType", "IsBroken", "Errors", "ErrorState" ], "properties": { "DisplayConnectionType": { "title": "String", "type": "string", "description": "Hypervisor connection connection type display name.", "minLength": 1 }, "IsBroken": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the hypervisor connection is broken." }, "Errors": { "title": "String[]", "type": "array", "description": "Hypervisor connection broken errors.", "items": { "title": "String", "type": "string" } }, "ErrorState": { "title": "String", "type": "string", "description": "Current hypervisor connection error status.", "minLength": 1 }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of hypervisor connections.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ResourcePools": { "title": "HypervisorBaseResponseModel[]", "type": "array", "description": "Hypervisor resource pools ref response list.", "nullable": true, "items": { "$ref": "#/components/schemas/HypervisorBaseResponseModel" } } } } ] }, "HypervisorsAndResourcePoolsResponseModelCollection": { "title": "HypervisorsAndResourcePoolsResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfHypervisorsAndResourcePoolsResponseModel" }, { "type": "object", "description": "Hypervisor and resource pools response model Collection model.", "additionalProperties": false } ] }, "HypervisorSecurityGroupResourceResponseModel": { "title": "HypervisorSecurityGroupResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "EgressRules", "IngressRules" ], "properties": { "Description": { "title": "String", "type": "string", "description": "Description of the security group.", "nullable": true }, "EgressRules": { "title": "HypervisorSecurityGroupRuleResponseModel[]", "type": "array", "description": "Egress rules governing outbound network traffic.", "items": { "$ref": "#/components/schemas/HypervisorSecurityGroupRuleResponseModel" } }, "IngressRules": { "title": "HypervisorSecurityGroupRuleResponseModel[]", "type": "array", "description": "Ingress rules governing inbound network traffic.", "items": { "$ref": "#/components/schemas/HypervisorSecurityGroupRuleResponseModel" } }, "VirtualPrivateCloudId": { "title": "String", "type": "string", "description": "The identifier of the associated VPC.", "nullable": true } } } ] }, "HypervisorSecurityGroupRuleResponseModel": { "title": "HypervisorSecurityGroupRuleResponseModel", "type": "object", "description": "Security group rule.", "additionalProperties": false, "required": [ "Protocol" ], "properties": { "FromPort": { "title": "Decimal", "type": "number", "description": "Start of the port number range, required for any protocol that uses ports.\nIn AWS this can also be an ICMP port number, where -1 specifies all ICMP types.", "format": "decimal", "nullable": true }, "GroupIds": { "title": "String[]", "type": "array", "description": "IDs of source or destination security groups. Empty when CIDR ranges are specified.", "nullable": true, "items": { "title": "String", "type": "string" } }, "IPRanges": { "title": "String[]", "type": "array", "description": "Source or destination CIDR address ranges. Empty if group IDs are specified.", "nullable": true, "items": { "title": "String", "type": "string" } }, "Protocol": { "title": "String", "type": "string", "description": "IP protocol name or number. In AWS this is the IP protocol name or number, where -1 specifies all protocols.\nProtocol numbers: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml", "minLength": 1 }, "ToPort": { "title": "Decimal", "type": "number", "description": "End of the port number range, required for any protocol that uses ports.\nIn AWS this can also be an ICMP port number, where -1 specfies all ICMP types.", "format": "decimal", "nullable": true } } }, "HypervisorServerHAAddressesResponseModel": { "title": "HypervisorServerHAAddressesResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorBaseResponseModel" }, { "type": "object", "description": "Hypervisor Server HA Addresses response model.", "additionalProperties": false, "properties": { "HAAddresses": { "title": "String[]", "type": "array", "description": "The HA addresses array.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "HypervisorServiceOfferingResourceResponseModel": { "title": "HypervisorServiceOfferingResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "MemorySizeMB", "NumberOfCores", "OptimizedForPooledDesktops", "NetworkPerformanceIsUnlimited", "NetworkPerformanceIsDefault", "IsUsedInSite" ], "properties": { "DedicatedTenancy": { "title": "String", "type": "string", "description": "Indicates whether this service offering prescribes dedicated tenancy for the instances\nthat use it.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "A human-readable description of this service offering, as supplied when the offering was created in the cloud\nmanagement API or console.", "nullable": true }, "MemorySizeMB": { "title": "Decimal", "type": "number", "description": "The amount of memory that is available to instances using this service offering, measured in megabytes.", "format": "decimal" }, "NumberOfCores": { "title": "Decimal", "type": "number", "description": "The number of virtual cores that are available to instances using this service offering.", "format": "decimal" }, "AmazonComputeUnits": { "title": "Decimal", "type": "number", "description": "The number of Amazon EC2 compute units that are available to instances using this service offering. This\nproperty is only meaningful for EC2-based cloud connections.", "format": "decimal", "nullable": true }, "OptimizedForPooledDesktops": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this service offering is intended specifically for usage with pooled\ndesktops." }, "NetworkPerformance": { "title": "String", "type": "string", "description": "The network performance available to instances using this service offering.", "nullable": true }, "NetworkPerformanceIsUnlimited": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this service offering has no limit for it's network rate." }, "NetworkPerformanceIsDefault": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this service offering has a default limit for it's network rate." }, "IsUsedInSite": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the service offering is used by any machine catalogs in the site." }, "SupportsAzurePremiumStorage": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the service offering supports premium storage.\nThis property is only meaningful on Azure.", "nullable": true } } } ] }, "HypervisorStorageResourceResponseModel": { "title": "HypervisorStorageResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "Superseded" ], "properties": { "Superseded": { "title": "Boolean", "type": "boolean", "description": "Indicates whether storage has been superseded. Superseded storage\nmay be used for existing virtual machines, but is not used when\nprovisioning new virtual machines." } } } ] }, "HypervisorTemplateResourceResponseModel": { "title": "HypervisorTemplateResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorVmSnapshotResourceResponseModel" }, { "type": "object", "description": "Cloud-based machine template.", "additionalProperties": false, "required": [ "HasPersistentRootVolume" ], "properties": { "Owner": { "title": "String", "type": "string", "description": "The account ID for the owner of this template.", "nullable": true }, "IsWindowsTemplate": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this is a Windows OS template, if known.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Human-readable description of this template, as supplied when the offering was created in the cloud\nmanagement API or console.", "nullable": true }, "HasPersistentRootVolume": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this template has a persistent root volume (eg. is an EBS-backed image\non AWS)." } } } ] }, "HypervisorTestResponseModel": { "title": "HypervisorTestResponseModel", "type": "object", "description": "Response object for a hypervisor test result.", "additionalProperties": false, "required": [ "Hypervisor", "NumPassed", "NumWarnings", "NumFailures" ], "properties": { "Hypervisor": { "description": "The hypervisor upon which the test was run.", "$ref": "#/components/schemas/RefResponseModel" }, "NumPassed": { "title": "Int32", "type": "integer", "description": "The number of tests that passed.", "format": "int32" }, "NumWarnings": { "title": "Int32", "type": "integer", "description": "The number of warnings that were found.", "format": "int32" }, "NumFailures": { "title": "Int32", "type": "integer", "description": "The number of tests that failed.", "format": "int32" }, "TestReport": { "description": "The detailed test report, only included when specifically requested in the API call.", "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } }, "HypervisorTraditionalConnectionDetailRequestModel": { "title": "HypervisorTraditionalConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "UserName", "Password", "Addresses" ], "properties": { "UserName": { "title": "String", "type": "string", "description": "Hypervisor username. Required.", "maxLength": 256, "minLength": 1, "pattern": "(.*)*" }, "Password": { "title": "String", "type": "string", "description": "Hypervisor password. Required. Must be specified in the format\nindicated by PasswordFormat.", "maxLength": 20480, "minLength": 1, "pattern": "(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*]).{8,}|^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|(.*)*" }, "PasswordFormat": { "description": "Format of the Password. Default is\nPlainText.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "Addresses": { "title": "String[]", "type": "array", "description": "Hypervisor address(es). At least one is required.", "items": { "title": "String", "type": "string" } }, "PluginId": { "title": "String", "type": "string", "description": "Custom hypervisor plugin ID. Required if the\nConnectionType is\nCustom. Otherwise must not\nbe specified.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "SslThumbprints": { "title": "String[]", "type": "array", "description": "SSL certificate thumbprints to consider acceptable for this\nconnection. Optional. If not specified, and the hypervisor uses\nSSL for its connection, the SSL certificate's root certification\nauthority and any intermediate certificates must be trusted.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "HypervisorVmResourceResponseModel": { "title": "HypervisorVmResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorVmSnapshotResourceResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "VMId" ], "properties": { "VMId": { "title": "String", "type": "string", "description": "Id of the VM, as defined by the hypervisor.", "minLength": 1 }, "MacAddress": { "title": "String", "type": "string", "description": "MAC address of the VM.", "nullable": true } } } ] }, "HypervisorVmSnapshotResourceResponseModel": { "title": "HypervisorVmSnapshotResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceResponseModel" }, { "type": "object", "additionalProperties": false, "properties": { "CpuCount": { "title": "Int32", "type": "integer", "description": "Number of CPUs, if known.", "format": "int32", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "Memory in megabytes, if known.", "format": "int32", "nullable": true }, "HardDiskSizeGB": { "title": "Int32", "type": "integer", "description": "Hard disk size in gigabytes, if known.", "format": "int32", "nullable": true }, "MinMemoryMB": { "title": "Int32", "type": "integer", "description": "Minimum memory required to run this VM or snapshot, in megabytes, if known.", "format": "int32", "nullable": true }, "NetworkMappings": { "title": "NetworkMapResponseModel[]", "type": "array", "description": "Network mappings associated with the VM, if known.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapResponseModel" } }, "AttachedDisks": { "title": "AttachedDiskResponseModel[]", "type": "array", "description": "Disks attached to the VM, if known.", "nullable": true, "items": { "$ref": "#/components/schemas/AttachedDiskResponseModel" } } } } ] }, "HypervisorVmValidationRequestModel": { "title": "HypervisorVmValidationRequestModel", "type": "object", "description": "A list of hypervisor vm path that need to be validated.", "additionalProperties": false, "properties": { "VmPaths": { "title": "String[]", "type": "array", "description": "A list of Vm path.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "HypervisorVmValidationResponseModel": { "title": "HypervisorVmValidationResponseModel", "type": "object", "additionalProperties": false, "properties": { "HypervisorVmResource": { "description": "Virtual machine info.", "nullable": true, "$ref": "#/components/schemas/HypervisorVmResourceResponseModel" }, "HypervisorConnection": { "description": "Response object for a hypervisor.", "nullable": true, "$ref": "#/components/schemas/HypervisorResponseModel" } } }, "HypervisorVmValidationResponseModelCollection": { "title": "HypervisorVmValidationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfHypervisorVmValidationResponseModel" }, { "type": "object", "description": "Collection of HypervisorVmValidationResponseModel", "additionalProperties": false } ] }, "HypervisorVpcResourceResponseModel": { "title": "HypervisorVpcResourceResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourceResponseModel" }, { "type": "object", "additionalProperties": false, "required": [ "InstanceSecurityGroupLimit" ], "properties": { "InstanceSecurityGroupLimit": { "title": "Int32", "type": "integer", "description": "Indicates the maximum number of security groups allowed per instance in this VPC", "format": "int32" } } } ] }, "HypervisorWOLConnectionDetailRequestModel": { "title": "HypervisorWOLConnectionDetailRequestModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorTraditionalConnectionDetailRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "SccmWakeUpProxy": { "title": "Boolean", "type": "boolean", "description": "Indicates whether Microsoft System Center Configuration Manager 2012\nSP1 Wake-up Proxy is used for power management. Optional; default\nis `false`.", "nullable": true }, "WakeOnLanPackets": { "description": "Indicates the Wake on LAN packet transmission method to use for\npower management. Optional; default is ", "default": "None", "nullable": true, "$ref": "#/components/schemas/WakeOnLanTransmission" } } } ] }, "IconDataResponseModel": { "title": "IconDataResponseModel", "type": "object", "description": "Icon data", "additionalProperties": false, "required": [ "RawData" ], "properties": { "RawData": { "title": "String", "type": "string", "description": "Raw icon data, Base64-encoded.", "minLength": 1 }, "FormattedData": { "title": "String", "type": "string", "description": "Icon data in the requested format for display. For example, if the caller\nrequested \"image/png;32x32x24\" image format, then this will be a 32x32,\n24bpp PNG-format image, Base64-encoded.\n\nIf the caller did not request an icon format, this will not be set.", "nullable": true } } }, "IconDiscoveryItemType": { "title": "IconDiscoveryItemType", "type": "string", "description": "Type to indicate icon discovery item type", "x-enumNames": [ "Unknown", "MachineShares", "DirectoryOrFiles", "Icon" ], "enum": [ "Unknown", "MachineShares", "DirectoryOrFiles", "Icon" ] }, "IconDiscoveryRequestModel": { "title": "IconDiscoveryRequestModel", "type": "object", "description": "Specify ApplicationGroups, DeliverGroups or MachineCatalogs to find the best machine to browse the files to get icons;\nOr specify machine IP/DnsName to browse application from the machine.\nIf both ApplicationGroups, DeliveryGroups, MachineCatalogs and ServerOrPath are specified, ServerOrPath will take priority.", "additionalProperties": false, "properties": { "ApplicationGroups": { "title": "String[]", "type": "array", "description": "The machines associated with Application Groups will be browsed.", "nullable": true, "example": [ "Name or Id of an application group" ], "items": { "title": "String", "type": "string" } }, "DeliveryGroups": { "title": "String[]", "type": "array", "description": "The machines associated with Delivery Groups will be browsed.", "nullable": true, "example": [ "Name or Id of a delivery group" ], "items": { "title": "String", "type": "string" } }, "MachineCatalogs": { "title": "String[]", "type": "array", "description": "The machines in the catalogs will be browsed.", "nullable": true, "example": [ "Name or Id of a catalog" ], "items": { "title": "String", "type": "string" } }, "ServerOrPath": { "title": "String", "type": "string", "description": "Specify machine IP or DNS to get machine shares;\nSpecify local path to get directory/files.", "nullable": true, "example": "serverName: \"MYSERVER\"; machine share: \"\\\\MYSERVER\\c$\"; path: \\\\MYSERVER\\c$\\Program Files" } } }, "IconDiscoveryResponseModel": { "title": "IconDiscoveryResponseModel", "type": "object", "description": "Response object for icon discovery.", "additionalProperties": false, "properties": { "Item": { "title": "String", "type": "string", "description": "Serialized string that is a list of machine shares,\nor a list of directories, or icon data that parsed.", "nullable": true }, "Type": { "description": "Indicating the item type", "$ref": "#/components/schemas/IconDiscoveryItemType" } } }, "IconResponseModel": { "title": "IconResponseModel", "allOf": [ { "$ref": "#/components/schemas/IconDataResponseModel" }, { "type": "object", "description": "Response object used for icon details.", "additionalProperties": false, "required": [ "Id", "IsBuiltIn" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the icon.", "minLength": 1 }, "IsBuiltIn": { "title": "Boolean", "type": "boolean", "description": "Indicates if the icon is built-in (i.e. Citrix-provided). The built-in icons\ncan be used for applications or desktops that don't have their own icons." }, "Uid": { "title": "Int32", "type": "integer", "description": "DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "Obsolete", "nullable": true } } } ] }, "IconResponseModelCollection": { "title": "IconResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfIconResponseModel" }, { "type": "object", "description": "Response object for collections of IconResponseModel.", "additionalProperties": false } ] }, "IdentityBaseResponseModel": { "title": "IdentityBaseResponseModel", "type": "object", "description": "Base Identity object for User, Machine and Container Identity objects.", "additionalProperties": false, "properties": { "Domain": { "title": "String", "type": "string", "description": "The Domain the object belongs to.\nNOTE: When doing a forest level search, the domain\nproperty is populated only if the object contains a SID\nand the SID was requested as property to be fetched.", "nullable": true }, "Forest": { "title": "String", "type": "string", "description": "The forest the object belongs to.", "nullable": true }, "Guid": { "title": "String", "type": "string", "description": "The GUID of the object, the GUID is unique\nacross the enterprise and anywhere else.", "nullable": true }, "DistinguishedName": { "title": "String", "type": "string", "description": "The Distinguished name of the object. Distinguished names (DNs)\nare unique and they unambiguously identify objects in the directory.", "nullable": true }, "CanonicalName": { "title": "String", "type": "string", "description": "The unique distinguished name of the object in canonical format.", "nullable": true }, "PossibleLookupFailure": { "title": "Boolean", "type": "boolean", "description": "Set to True during a bulk identity lookup operation.\nFor individual identity lookup, usually an exception will be thrown." }, "DirectoryServer": { "title": "String", "type": "string", "description": "Domain controller that performed the add/update operation on this object", "nullable": true } } }, "IdentityClaimsResponseModel": { "title": "IdentityClaimsResponseModel", "type": "object", "description": "The identity claims object.", "additionalProperties": false, "properties": { "Oid": { "title": "String", "type": "string", "description": "Oid claim of the identity.", "nullable": true }, "Sid": { "title": "String", "type": "string", "description": "Sid claim of the identity.", "nullable": true }, "Upn": { "title": "String", "type": "string", "description": "Upn claim of the identity.", "nullable": true }, "Email": { "title": "String", "type": "string", "description": "Email claim of the identity.", "nullable": true } } }, "IdentityContainerResponseModel": { "title": "IdentityContainerResponseModel", "allOf": [ { "$ref": "#/components/schemas/IdentityBaseResponseModel" }, { "type": "object", "description": "The Container identity object.", "additionalProperties": false, "required": [ "PropertiesFetched" ], "properties": { "Name": { "title": "String", "type": "string", "description": "The name of the container.", "nullable": true }, "Type": { "description": "The container type represented in this object.", "$ref": "#/components/schemas/IdentityContainerType" }, "PropertiesFetched": { "title": "UInt32", "type": "integer", "description": "Properties fetched and populated in the Container object. This is a bitfield indicating the fetched properties." } } } ] }, "IdentityContainerResponseModelCollection": { "title": "IdentityContainerResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfIdentityContainerResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "IdentityContainerType": { "title": "IdentityContainerType", "type": "string", "description": "The type of Container identity object to retrieve.", "x-enumNames": [ "Unknown", "OrganizationalUnit", "Container", "LostAndFound", "BuiltInDomain" ], "enum": [ "Unknown", "OrganizationalUnit", "Container", "LostAndFound", "BuiltInDomain" ] }, "IdentityCreateMachineRequestModel": { "title": "IdentityCreateMachineRequestModel", "type": "object", "description": "Add a machine identity.", "additionalProperties": false, "required": [ "Forest", "Name", "AccountPassword" ], "properties": { "Forest": { "title": "String", "type": "string", "description": "Forest in which to create the machine identity.", "maxLength": 255, "minLength": 1, "pattern": "UNKNOWN", "example": "For example, test.local" }, "Domain": { "title": "String", "type": "string", "description": "Domain in which to create the machine identity.", "maxLength": 255, "pattern": "^(?=^.{2,15}$)(?=^[^\\\\\\/:\\*\\?\"<>|,~!@$%^&'(){}_\\s]*$).*$", "nullable": true, "example": "For example, test.local" }, "Name": { "title": "String", "type": "string", "description": "The machine identity to create.", "maxLength": 15, "minLength": 1, "pattern": "^(?=^.{2,15}$)(?=^[^\\\\\\/:\\*\\?\"<>|,~!@$%^&'`=+;.(){}_\\s]*$)(?=^[^\\.])(?=^.*[^\\d].*$).*(?|,~!@$%^&'(){}_\\s]*$).*$", "nullable": true, "example": "For example, test.local" }, "LogOnType": { "description": "Logon type to use. Default is NetworkClearText.", "default": "NetworkClearText", "nullable": true, "$ref": "#/components/schemas/IdentityLogonType" }, "UserName": { "title": "String", "type": "string", "description": "Username to validate. Required.", "maxLength": 255, "minLength": 1, "pattern": "^(?=^.{2,15}$)(?=^[^\\\\\\/:\\*\\?\"<>|,~!@$%^&'(){}_\\s]*$).*$", "example": "For example, administrator" }, "Password": { "title": "String", "type": "string", "description": "Password to validate. Required.\nMust be specified in the format indicated by PasswordFormat.", "maxLength": 20480, "minLength": 1, "pattern": "(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*]).{8,}|^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|(.*)*", "example": "For example, password" }, "PasswordFormat": { "description": "Format of the Password. Default is PlainText.", "default": "PlainText", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" } } }, "ImageDefinitionAndImageVersionSearchRequestModel": { "title": "ImageDefinitionAndImageVersionSearchRequestModel", "type": "object", "description": "Request model for defining advanced image definition and image version search criteria.", "additionalProperties": false, "properties": { "ResourcePool": { "title": "String", "type": "string", "description": "Resource pool in which to search for the image definition and image version.", "nullable": true }, "VDASessionSupport": { "description": "VDA session support in which to search for the image definition.", "nullable": true, "$ref": "#/components/schemas/SessionSupport" }, "OsType": { "description": "OS Type in which to search for the image definition.", "nullable": true, "$ref": "#/components/schemas/OsType" } } }, "ImageDefinitionErrorWarningModel": { "title": "ImageDefinitionErrorWarningModel", "allOf": [ { "$ref": "#/components/schemas/ErrorWarningModel" }, { "type": "object", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "nullable": true }, "Name": { "title": "String", "type": "string", "nullable": true } } } ] }, "ImageDefinitionHypervisorConnectionResponseModel": { "title": "ImageDefinitionHypervisorConnectionResponseModel", "allOf": [ { "$ref": "#/components/schemas/RefResponseModel" }, { "type": "object", "description": "Assignment of hypervisor connection to an image definition.", "additionalProperties": false, "properties": { "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the image definition that are specific to the target hypervisor connection.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "HypervisorData": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Hypervisor data about the object in the form of key-value pairs.\nTODO AdditionalData or HypervisorData?", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "PluginFactoryName": { "title": "String", "type": "string", "description": "The connection plugin factory name.", "nullable": true } } } ] }, "ImageDefinitionResponseModel": { "title": "ImageDefinitionResponseModel", "type": "object", "description": "Response object for image definition.", "additionalProperties": false, "required": [ "Id", "OsType", "LatestVersion", "VDASessionSupport" ], "properties": { "Id": { "title": "String", "type": "string", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "the name of the image definition", "nullable": true }, "CreationTime": { "title": "String", "type": "string", "description": "the create date for this image definition", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "description", "nullable": true }, "OsType": { "description": "string type of OsType", "$ref": "#/components/schemas/OsType" }, "LatestVersion": { "title": "Int32", "type": "integer", "description": "the latest version for the image definition", "format": "int32" }, "VDASessionSupport": { "description": "The vda supported session type", "$ref": "#/components/schemas/SessionSupport" }, "HypervisorConnections": { "title": "ImageDefinitionHypervisorConnectionResponseModel[]", "type": "array", "description": "The hypervisor connections on which image definition is associated.", "nullable": true, "items": { "$ref": "#/components/schemas/ImageDefinitionHypervisorConnectionResponseModel" } }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "Gets or sets the array of administration scopes", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } } } }, "ImageDefinitionResponseModelCollection": { "title": "ImageDefinitionResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfImageDefinitionResponseModel" }, { "type": "object", "description": "Response object for collections of ImageDefinitionResponseModel.", "additionalProperties": false } ] }, "ImageDefinitionsAndImageVersionsResponseModel": { "title": "ImageDefinitionsAndImageVersionsResponseModel", "type": "object", "description": "Response object for image definition and associated image versions.", "additionalProperties": false, "required": [ "OsType", "LatestVersion", "VDASessionSupport" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Uid of the image definition.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "The name of the image definition.", "nullable": true }, "CreationTime": { "title": "String", "type": "string", "description": "The create date for this image definition.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description.", "nullable": true }, "OsType": { "description": "OS Type.", "$ref": "#/components/schemas/OsType" }, "LatestVersion": { "title": "Int32", "type": "integer", "description": "The latest version for the image definition.", "format": "int32" }, "VDASessionSupport": { "description": "The VDA supported session type.", "$ref": "#/components/schemas/SessionSupport" }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "Gets or sets the array of image scopes", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "HypervisorConnections": { "title": "ImageDefinitionHypervisorConnectionResponseModel[]", "type": "array", "description": "The hypervisor connections on which image definition is associated.", "nullable": true, "items": { "$ref": "#/components/schemas/ImageDefinitionHypervisorConnectionResponseModel" } }, "ImageVersions": { "title": "ImageVersionResponseModel[]", "type": "array", "description": "The image versions associated with this image definition.", "nullable": true, "items": { "$ref": "#/components/schemas/ImageVersionResponseModel" } } } }, "ImageDefinitionsAndImageVersionsResponseModelCollection": { "title": "ImageDefinitionsAndImageVersionsResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfImageDefinitionsAndImageVersionsResponseModel" }, { "type": "object", "description": "Response object for collections of ImageDefinitionsAndImageVersionsResponseModel.", "additionalProperties": false } ] }, "ImageRuntimeEnvironmentResponseModel": { "title": "ImageRuntimeEnvironmentResponseModel", "type": "object", "description": "The runtime information on image", "additionalProperties": false, "properties": { "OperatingSystem": { "description": "Operating system information model", "nullable": true, "$ref": "#/components/schemas/OperatingSystemInfoResponseModel" }, "VDASessionSupport": { "title": "String", "type": "string", "description": "The session support type of VDA in master image", "nullable": true }, "IdentityJoinStatus": { "title": "String", "type": "string", "description": "Identity join status.", "nullable": true }, "DeviceEnrollmentStatus": { "title": "String", "type": "string", "description": "The enrollment mode (MDMEnrolled/MAMEnrolled/Unknown).", "nullable": true }, "PagingFileSettings": { "title": "PagingFileSettingResponseModel[]", "type": "array", "description": "System paging file settings.", "nullable": true, "items": { "$ref": "#/components/schemas/PagingFileSettingResponseModel" } }, "Capabilities": { "title": "IDictionary`2", "type": "object", "description": "Master image's capabilities, such as 'AzureAdSupported', 'HybridAzureAdSupported', 'IntuneSupported'", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "VDAComponents": { "title": "IDictionary`2", "type": "object", "description": "Master image's VDA's components, such as 'MCS IO', 'Machine Identity Service Agent'", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } } } }, "ImageSchemeResponseModel": { "title": "ImageSchemeResponseModel", "type": "object", "description": "Response object for image scheme.", "additionalProperties": false, "required": [ "Id" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Id of the image scheme.", "minLength": 1 }, "CpuCount": { "title": "Int32", "type": "integer", "description": "The number of processors that VMs will be created with when using this scheme.", "format": "int32" }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the image scheme that are specific to the target hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "CustomPropertiesInString": { "title": "String", "type": "string", "description": "The properties of the image scheme that are specific to the target hosting infrastructure in string format.", "nullable": true }, "MachineProfile": { "description": "The machine profile that the scheme uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "SourceMachineProfile": { "title": "String", "type": "string", "description": "The source machine profile that the scheme uses.", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "The maximum amount of memory that VMs will be created with when using this scheme.", "format": "int32" }, "NetworkMaps": { "title": "NetworkMapResponseModel[]", "type": "array", "description": "Networks used by image scheme.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapResponseModel" } }, "ServiceOffering": { "title": "String", "type": "string", "description": "Service offering used by Cloud provisioned VMs.", "nullable": true } } }, "ImagesErrorWarningModel": { "title": "ImagesErrorWarningModel", "allOf": [ { "$ref": "#/components/schemas/ErrorWarningModel" }, { "type": "object", "additionalProperties": false, "properties": { "ErrorWarning": { "title": "ImageDefinitionErrorWarningModel[]", "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ImageDefinitionErrorWarningModel" } } } } ] }, "ImageUpdateStatus": { "title": "ImageUpdateStatus", "type": "string", "description": "The machines image update status of a catalog", "x-enumNames": [ "Unknown", "UpdateToDate", "PartiallyUpdated", "PendingUpdate", "PreparingImage" ], "enum": [ "Unknown", "UpdateToDate", "PartiallyUpdated", "PendingUpdate", "PreparingImage" ] }, "ImageUpdateTaskDetaiResponseModel": { "title": "ImageUpdateTaskDetaiResponseModel", "allOf": [ { "$ref": "#/components/schemas/MaintenanceCycleTaskDetailResponseModel" }, { "type": "object", "description": "Response object for a task of image update.", "additionalProperties": false, "properties": { "MasterImage": { "description": "The master image assignment applied to the provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "ImageVersionSpec": { "description": "The image version assignment applied to the provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/ImageVersionSpecRefResponseModel" }, "RolloutStrategy": { "description": "Rollout strategy for updating VMs with the new image.", "$ref": "#/components/schemas/RolloutStrategy" } } } ] }, "ImageVersionProvisioningSchemeRefResponseModel": { "title": "ImageVersionProvisioningSchemeRefResponseModel", "allOf": [ { "$ref": "#/components/schemas/RefResponseModel" }, { "type": "object", "description": "Reference from a image version to a provisioning scheme.", "additionalProperties": false } ] }, "ImageVersionProvisioningSchemeRefResponseModelCollection": { "title": "ImageVersionProvisioningSchemeRefResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfImageVersionProvisioningSchemeRefResponseModel" }, { "type": "object", "description": "Response object for collections of ImageVersionProvisioningSchemeRefResponseModel.", "additionalProperties": false } ] }, "ImageVersionRefResponseModel": { "title": "ImageVersionRefResponseModel", "type": "object", "description": "Image version reference.", "additionalProperties": false, "required": [ "Id", "Number", "ImageDefinition" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Id of the image version.", "minLength": 1 }, "Number": { "title": "Int32", "type": "integer", "description": "The version number associated with the image version.", "format": "int32" }, "ImageDefinition": { "description": "The image definition associated with this image version.", "$ref": "#/components/schemas/RefResponseModel" }, "Description": { "title": "String", "type": "string", "description": "The image version's description", "nullable": true }, "ImageVersionSpecs": { "title": "ImageVersionSpecRefResponseModel[]", "type": "array", "description": "The image version specifications associated with this image version.", "nullable": true, "items": { "$ref": "#/components/schemas/ImageVersionSpecRefResponseModel" } } } }, "ImageVersionResourcePoolRequestModel": { "title": "ImageVersionResourcePoolRequestModel", "type": "object", "description": "Image Version resource pool request object.", "additionalProperties": false, "properties": { "ResourcePool": { "title": "String", "type": "string", "description": "Hypervisor resource pool Id or name with which image version associates", "nullable": true }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the image that are specific to the\ntarget hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "ImageVersionResponseModel": { "title": "ImageVersionResponseModel", "type": "object", "description": "Response object for image version.", "additionalProperties": false, "required": [ "Id", "Number", "ImageDefinition" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Id of the image version.", "minLength": 1 }, "Number": { "title": "Int32", "type": "integer", "description": "The version number associated with the image version.", "format": "int32" }, "CreationTime": { "title": "String", "type": "string", "description": "Time when the image version was created.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The Description of the image version.", "nullable": true }, "ImageVersionStatus": { "description": "The image status of the image version.", "$ref": "#/components/schemas/ImageVersionStatus" }, "ImageDefinition": { "description": "The image definition associated with this image version.", "$ref": "#/components/schemas/RefResponseModel" }, "ImageVersionSpecs": { "title": "ImageVersionSpecResponseModel[]", "type": "array", "description": "The image version specifications associated with this image version.", "nullable": true, "items": { "$ref": "#/components/schemas/ImageVersionSpecResponseModel" } }, "ProvisioningSchemeCount": { "title": "Int32", "type": "integer", "description": "The count of provisioning schemes", "format": "int32" }, "CriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "Critical issues (errors) associated with this image version.", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfImageVersionSpecErrorType" } }, "NonCriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "Non-critical issues (warnings) associated with this image version.", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfImageVersionSpecWarningType" } } } }, "ImageVersionResponseModelCollection": { "title": "ImageVersionResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfImageVersionResponseModel" }, { "type": "object", "description": "Response object for collections of ImageVersionResponseModel.", "additionalProperties": false } ] }, "ImageVersionSpecContextResponseModel": { "title": "ImageVersionSpecContextResponseModel", "type": "object", "description": "Response object for image version specification.", "additionalProperties": false, "properties": { "AdditionalData": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Additional data about the object in the form of key-value pairs.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ImageScheme": { "description": "Image scheme about how machines in a image version specification are provisioned.", "nullable": true, "$ref": "#/components/schemas/ImageSchemeResponseModel" }, "MachineProfileMetadata": { "description": "The metadata of machine profile that the image version specification uses.", "nullable": true, "$ref": "#/components/schemas/MachineProfileMetadataResponseModel" }, "PluginFactoryName": { "title": "String", "type": "string", "description": "Custom hypervisor plugin.", "nullable": true }, "MachineAgentOptions": { "description": "Machine agent options.", "$ref": "#/components/schemas/MachineAgentOptions" } } }, "ImageVersionSpecErrorResponseModel": { "title": "ImageVersionSpecErrorResponseModel", "type": "object", "additionalProperties": false, "properties": { "ErrorType": { "description": "Gets or sets the type of error that occurred when processing the image version specification.", "$ref": "#/components/schemas/ImageVersionSpecErrorType" }, "ErrorMessage": { "title": "String", "type": "string", "description": "Gets or sets a descriptive message providing details about the image version specification error.", "nullable": true } } }, "ImageVersionSpecErrorType": { "title": "ImageVersionSpecErrorType", "type": "string", "description": "", "x-enumNames": [ "Unknown", "MasterVMNotFound", "FailedToReadMachineProfile", "UnableToFindHostingUnit", "NoPreparedImages", "FailedToCreateImagePreparationVm" ], "enum": [ "Unknown", "MasterVMNotFound", "FailedToReadMachineProfile", "UnableToFindHostingUnit", "NoPreparedImages", "FailedToCreateImagePreparationVm" ] }, "ImageVersionSpecRefResponseModel": { "title": "ImageVersionSpecRefResponseModel", "type": "object", "description": "Image version specification reference.", "additionalProperties": false, "required": [ "Id", "PreparationType", "ResourcePool" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Id of the image version specification.", "minLength": 1 }, "PreparationType": { "description": "Specifies how the image is prepared.", "$ref": "#/components/schemas/PreparationType" }, "ResourcePool": { "description": "The resource pool on which images are prepared.", "$ref": "#/components/schemas/HypervisorResourcePoolRefResponseModel" } } }, "ImageVersionSpecResourcePoolResponseModel": { "title": "ImageVersionSpecResourcePoolResponseModel", "allOf": [ { "$ref": "#/components/schemas/HypervisorResourcePoolRefResponseModel" }, { "type": "object", "description": "Assignment of resource pool to an image version.", "additionalProperties": false, "properties": { "IsPrimary": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the resource pool is the primary resource pool for the image version.\nResource pool used to prepare the image is the default primary resource pool." }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the image that are specific to the target hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "CustomPropertiesInString": { "title": "String", "type": "string", "description": "The properties of the image that are specific to the target hosting infrastructure in string format.", "nullable": true }, "Errors": { "title": "String[]", "type": "array", "description": "The errors in this image version specification within this resource pool.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ImageVersionSpecResourcePoolStatus": { "description": "The status of an image version specification within this resource pool.", "$ref": "#/components/schemas/ImageVersionSpecResourcePoolStatus" }, "MachineProfile": { "description": "The machine profile that the image version spec hosting unit uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "SourceMachineProfile": { "title": "String", "type": "string", "description": "The source machine profile that the image version spec hosting unit uses.", "nullable": true } } } ] }, "ImageVersionSpecResourcePoolStatus": { "title": "ImageVersionSpecResourcePoolStatus", "type": "string", "description": "Status of an image version spec within a specific resource pool.", "x-enumNames": [ "Unknown", "InProgress", "Success", "Failed", "Deleting" ], "enum": [ "Unknown", "InProgress", "Success", "Failed", "Deleting" ] }, "ImageVersionSpecResponseModel": { "title": "ImageVersionSpecResponseModel", "type": "object", "description": "Response object for image version specification.", "additionalProperties": false, "required": [ "Id", "PreparationType" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Id of the image version specification.", "minLength": 1 }, "Context": { "description": "Context about the image version specification.", "nullable": true, "$ref": "#/components/schemas/ImageVersionSpecContextResponseModel" }, "CreationTime": { "title": "String", "type": "string", "description": "The create time of the image version specification.", "nullable": true }, "Errors": { "title": "String[]", "type": "array", "description": "The errors in this image version specification", "nullable": true, "items": { "title": "String", "type": "string" } }, "DetailedErrors": { "title": "ImageVersionSpecErrorResponseModel[]", "type": "array", "description": "The detailed errors in this image version specification", "nullable": true, "items": { "$ref": "#/components/schemas/ImageVersionSpecErrorResponseModel" } }, "ImageRuntimeEnvironment": { "description": "Image runtime environment information.", "nullable": true, "$ref": "#/components/schemas/ImageRuntimeEnvironmentResponseModel" }, "ImageVersionSpecStatus": { "description": "The status of an image version specification.", "$ref": "#/components/schemas/ImageVersionSpecStatus" }, "MasterImage": { "description": "The master image that the image version specification uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "PreparationType": { "description": "Specifies how the image is prepared.", "$ref": "#/components/schemas/PreparationType" }, "ProvisioningSchemeCount": { "title": "Int32", "type": "integer", "description": "Number of provisioning scheme created from this image version specification.", "format": "int32" }, "ResourcePool": { "description": "The resource pool on which image is prepared.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolRefResponseModel" }, "ResourcePools": { "title": "ImageVersionSpecResourcePoolResponseModel[]", "type": "array", "description": "The resource pools on which image is associated.", "nullable": true, "items": { "$ref": "#/components/schemas/ImageVersionSpecResourcePoolResponseModel" } }, "SourceImageVersionSpec": { "description": "The reference to the image version specification from which this specification is derived.", "nullable": true, "$ref": "#/components/schemas/ImageVersionSpecRefResponseModel" }, "DiskSize": { "title": "Int32", "type": "integer", "description": "The disk size", "format": "int32" }, "Warnings": { "title": "ImageVersionSpecWarningResponseModel[]", "type": "array", "description": "List of warnings that are currently active on the image version specification,\nif any. If there are no warnings this will not be specified.", "nullable": true, "items": { "$ref": "#/components/schemas/ImageVersionSpecWarningResponseModel" } }, "Zone": { "description": "Zone which the image version specification is associated with.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" } } }, "ImageVersionSpecStatus": { "title": "ImageVersionSpecStatus", "type": "string", "description": "Status of an image version specification.", "x-enumNames": [ "Unknown", "InProgress", "Success", "Failed" ], "enum": [ "Unknown", "InProgress", "Success", "Failed" ] }, "ImageVersionSpecWarningResponseModel": { "title": "ImageVersionSpecWarningResponseModel", "type": "object", "description": "Describes a warning on an image version specification.", "additionalProperties": false, "required": [ "Type" ], "properties": { "Type": { "description": "Type of warning.", "$ref": "#/components/schemas/ImageVersionSpecWarningType" }, "Message": { "title": "String", "type": "string", "description": "Message associated with warning", "nullable": true } } }, "ImageVersionSpecWarningType": { "title": "ImageVersionSpecWarningType", "type": "string", "description": "Types of warnings that may occur on a machine catalog.", "x-enumNames": [ "Unknown", "ImagePreparationOfficeRearmCountExceeded", "ImagePreparationOfficeRearmFailed", "ImagePreparationOSRearmCountExceeded", "ImagePreparationOSRearmFailed", "GetMachineProfileMetadataFailed", "GetCustomPropertiesFailed", "ImageAction" ], "enum": [ "Unknown", "ImagePreparationOfficeRearmCountExceeded", "ImagePreparationOfficeRearmFailed", "ImagePreparationOSRearmCountExceeded", "ImagePreparationOSRearmFailed", "GetMachineProfileMetadataFailed", "GetCustomPropertiesFailed", "ImageAction" ] }, "ImageVersionStatus": { "title": "ImageVersionStatus", "type": "string", "description": "Status of an image version.", "x-enumNames": [ "Unknown", "InProgress", "Success", "Failed" ], "enum": [ "Unknown", "InProgress", "Success", "Failed" ] }, "ImportMachineStatus": { "title": "ImportMachineStatus", "type": "string", "description": "ImportMachineStatus enum.", "x-enumNames": [ "Unknown", "ImportFailed", "AddToCatalogFailed", "Success" ], "enum": [ "Unknown", "ImportFailed", "AddToCatalogFailed", "Success" ] }, "ImportProvisionedVirtualMachineResponseModel": { "title": "ImportProvisionedVirtualMachineResponseModel", "type": "object", "description": "Provisioned Virtual machine Response model class.", "additionalProperties": false, "properties": { "ADAccountSid": { "title": "String", "type": "string", "description": "The Sid of the virtual machine.", "nullable": true }, "VMId": { "title": "String", "type": "string", "description": "The virtual machine Id.", "nullable": true }, "VMName": { "title": "String", "type": "string", "description": "The virtual machine name.", "nullable": true }, "FailureReason": { "title": "String", "type": "string", "description": "Failure reason.", "nullable": true }, "Status": { "description": "Add machine to MCS catalog succeed.", "$ref": "#/components/schemas/ImportMachineStatus" } } }, "ImportProvisionedVirtualMachineResponseModelCollection": { "title": "ImportProvisionedVirtualMachineResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfImportProvisionedVirtualMachineResponseModel" }, { "type": "object", "description": "Import Provisioned virtual machine response model class.", "additionalProperties": false } ] }, "ImportProvisionedVirtualMachinesRequestModel": { "title": "ImportProvisionedVirtualMachinesRequestModel", "type": "object", "description": "ProvisionedVirtualMachinesRequestModel class.", "additionalProperties": false, "properties": { "ProvisionedVirtualMachinesData": { "title": "String", "type": "string", "description": "On-Prem Provisioned virtual machines data.", "nullable": true } } }, "InstalledAppResponseModel": { "title": "InstalledAppResponseModel", "type": "object", "description": "Response object for installed application properties.", "additionalProperties": false, "required": [ "CommandLineArguments", "CommandLineExecutable", "WorkingDirectory" ], "properties": { "CommandLineArguments": { "title": "String", "type": "string", "description": "The command-line arguments to use when launching the\nexecutable. Environment variables can be used.", "minLength": 1 }, "CommandLineExecutable": { "title": "String", "type": "string", "description": "The name of the executable file to launch. The full\npath need not be provided if it's already in the path.\nEnvironment variables can also be used.", "minLength": 1 }, "WorkingDirectory": { "title": "String", "type": "string", "description": "The working directory which the executable is launched\nfrom. Environment variables can be used. ", "minLength": 1 } } }, "IntelligentAutoscaleGroupPluginResponseModel": { "title": "IntelligentAutoscaleGroupPluginResponseModel", "allOf": [ { "$ref": "#/components/schemas/AutoscaleGroupPluginResponseModel" }, { "type": "object", "description": "Intelligent autoscale group plugin response model.", "additionalProperties": false } ] }, "IssueModelOfCatalogErrorType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/CatalogErrorType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfDeliveryGroupCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/DeliveryGroupCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfDeliveryGroupNonCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/DeliveryGroupNonCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfHypervisorCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/HypervisorCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfHypervisorNonCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/HypervisorNonCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfImageVersionSpecErrorType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/ImageVersionSpecErrorType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfImageVersionSpecWarningType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/ImageVersionSpecWarningType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfMachineCatalogWarningType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/MachineCatalogWarningType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfMachineCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/MachineCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfMachineNonCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/MachineNonCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfServiceAccountCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/ServiceAccountCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfServiceAccountNonCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/ServiceAccountNonCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfSiteCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/SiteCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfSiteNonCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/SiteNonCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfZoneCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/ZoneCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueModelOfZoneNonCriticalIssueType": { "title": "IssueModel`1", "type": "object", "description": "Base class for critical and non-critical issues.", "additionalProperties": false, "properties": { "Type": { "description": "The type of the issue, which can be a critical or non-critical issue type.\n ", "$ref": "#/components/schemas/ZoneNonCriticalIssueType" }, "Message": { "title": "String", "type": "string", "description": "The user-friendly message to display.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "The detailed message for investigation.", "nullable": true } } }, "IssueSearchFilterType": { "title": "IssueSearchFilterType", "type": "string", "description": "The type of issue filter to apply when searching for delivery groups.", "x-enumNames": [ "None", "Critical", "NonCritical" ], "enum": [ "None", "Critical", "NonCritical" ] }, "JobErrorCode": { "title": "JobErrorCode", "type": "string", "description": "Possible error codes returned from a job.", "x-enumNames": [ "Unknown", "UnknownError", "AccessDenied", "PermissionDenied", "UserNotAuthorized", "AuthorizationFailed", "AuthorizationError", "DeniedByConfigurationLogging", "DataStoreUnconfigured", "SiteUnconfigured", "MissingDbSchemaFeature", "DatabaseNotConfigured", "ObjectNotFound", "UnknownObject", "UnknownAccount", "UnknownCatalog", "UnknownController", "UnknownMachine", "UnknownDesktop", "ScopeNotFound", "UnknownMachineName", "UnknownApplication", "UnknownIcon", "UnknownPolicyRule", "UnknownFileTypeExtension", "UnknownConfiguredFTA", "UnknownImportedFTA", "UnknownDesktopTag", "DesktopTagInUse", "UnknownHypervisorConnection", "UnknownPowerTimeScheme", "UnknownDumScheme", "UnknownPowerAction", "UnknownSession", "UnknownConfigurationSlot", "UnknownRebootSchedule", "LACNotFound", "HypervisorConnectionObjectNotFound", "PathNotFound", "DriveNotFound", "IdentityPoolOUInvalid", "ProvisioningSchemeNotFound", "IdentityPoolObjectNotFound", "HostingUnitNotFound", "AppDNASolutionNotFound", "BrokerMachineNotFound", "MCSDiskCopyTaskNotFound", "AppDiskNotFound", "AppDNAOperatingSystemNotFound", "MultipleRelationshipsSpecified", "NoRelationshipSpecified", "NoMatchingItems", "InvalidTimeZone", "InvalidScheduleStartTime", "InvalidStatusUpdatingFTA", "UserAccountRequired", "MustSupplyNameOrSID", "MustNotSupplyBothNameAndSID", "ConstraintViolation", "UnsupportedWildcard", "InvalidSecurityIdentifier", "InvalidIconData", "PvsForVMInvalid", "PvsDetailsRequired", "PvsDetailsInvalid", "MachinesArePhysicalRequired", "MachinesArePhysicalConflict", "MissingHostingData", "SuperfluousHostingData", "MultiSessionPoolManagementNotSupported", "MultipleUserAssignments", "MultipleDesktopAssignments", "PolicyRuleAppliedToMultipleApps", "ImportedFTACorrupted", "PowerTimeSchemeDaysOverlap", "SidMissingForEvictScript", "SidSuppliedForNonEvictScript", "MachineHypMcIdAlone", "InvalidRebootScheduleDay", "InvalidCommandRecipient", "InvalidAccount", "LACNotSupported", "WebkeyNotSupported", "InvalidLicenseFile", "EmptyLicenseFile", "InvalidLicenseFileExtension", "PollingIntervalMoreThanMaxValue", "PollingIntervalLessThanMinValue", "RetentionPeriodLessThanMinValue", "InvalidStartDateOrEndDate", "InvalidProductEditionModelFormat", "InvalidCEIPOption", "IdentityPoolOUOfWrongDomain", "NamingSchemeHasMoreThanOneSetOfHashes", "NamingSchemeIllegalCharacter", "NamingSchemeIllegalComputerName", "NamingSchemeMayNotBeAllNumbers", "NamingSchemeMayNotStartWithPeriod", "NamingSchemeMissingNumericSpecifications", "NamingSchemeNotEnoughCharacters", "NamingSchemeTooManyCharacters", "NamingSchemeUnicodeCharactersNotEnabled", "MCSCopyFailureInvalidVirtualDiskId", "InvalidMachineId", "DuplicateAppDisplayName", "DuplicateAppBrowserName", "DuplicateAdministrator", "DuplicateRebootSchedule", "DuplicateObject", "AdminAlreadyExists", "RoleAlreadyExists", "ScopeAlreadyExists", "HostingUnitDuplicateObjectExists", "ProvisioningSchemeNameAlreadyExists", "IdentityPoolDuplicateObjectExists", "AppDiskNameAlreadyExists", "DuplicateAutoscaleGroupPluginName", "CommunicationError", "NoServerErrorId", "InvalidServerPortString", "InvalidPortNumber", "InvalidServerGuid", "InvalidServerVersion", "ServerTimeout", "InvalidIPAddress", "NoSuitableServiceInstanceErrorId", "CommunicationsError", "CitrixLicensingVendorOrServiceDown", "CanNotImportStartUpLic", "CommunicationSecurityError", "InvalidArgument", "UpdateCacheInvalidArgument", "DataStoreException", "UnknownOperation", "DataStoreAlreadyConfigured", "MachineNotRegistered", "PowerManagedController", "DesktopGroupInUse", "MachineInUse", "CatalogInUse", "ApplicationInUse", "MachineAlreadyAllocated", "MachineNotInDesktopGroup", "MachineInDesktopGroup", "IncompatibleMachine", "IncompatibleDesktopUsage", "IncompatibleDesktopAssignment", "IncompatibleDesktopGroup", "IncompatibleCatalog", "DesktopAssigned", "InMaintenanceMode", "GroupInMaintenanceMode", "IconInUse", "NoAvailableMachine", "PowerTimeSchemeInUse", "IncompatibleDumScheme", "HypervisorInMaintenanceMode", "PowerActionsNotSupported", "PowerActionInProgress", "PowerActionComplete", "PowerActionIgnored", "PowerActionNotStarted", "ServiceGroupNotAllowed", "MachineConfigurationInUse", "NoEntitlements", "LastFullAdmin", "HypervisorConnectionForHostingUnitIsVirtual", "HostingUnitNetworkPathInvalid", "HostingUnitRootPathInvalid", "HostingUnitStoragePathInvalid", "InvalidHypervisorItem", "VMAlreadyUnlocked", "AppDiskInUse", "TaskActive", "AppDiskAlreadySealed", "AppVPackageImportError", "NoRemainingDeliveryGroups", "NameResolutionFailure", "HypervisorAddressInvalidFormat", "HypervisorPermissionDenied", "SCVMMConsoleNotInstalled", "ConnectionNotVCenter", "ConnectionExpiredCredentials", "ConnectionInvalidCredentials", "VCenterConnectionSslFailure", "XenServerConnectionSslFailure", "HypervisorNotContactable", "NoWorkspaceCloudConnectorFound", "WorkspaceCloudConnectorTimeout", "WorkspaceCloudConnectorEndpointNotFound", "VCenterHttpsConnectionRequiredForEndpoint", "MoonshotConnectionSslFailure", "MoonshotConnectionSslPrivateCASignedFailure", "MoonshotConnectionSslPublicCASignedFailure", "OpenShiftConnectionSslPublicCASignedFailure", "AWSAssumeRoleAuthenticationFailure", "AmuletHotkeyCoreStationConnectionSslFailure", "AmuletHotkeyCoreStationConnectionSslPrivateCASignedFailure", "AmuletHotkeyCoreStationConnectionSslPublicCASignedFailure" ], "enum": [ "Unknown", "UnknownError", "AccessDenied", "PermissionDenied", "UserNotAuthorized", "AuthorizationFailed", "AuthorizationError", "DeniedByConfigurationLogging", "DataStoreUnconfigured", "SiteUnconfigured", "MissingDbSchemaFeature", "DatabaseNotConfigured", "ObjectNotFound", "UnknownObject", "UnknownAccount", "UnknownCatalog", "UnknownController", "UnknownMachine", "UnknownDesktop", "ScopeNotFound", "UnknownMachineName", "UnknownApplication", "UnknownIcon", "UnknownPolicyRule", "UnknownFileTypeExtension", "UnknownConfiguredFTA", "UnknownImportedFTA", "UnknownDesktopTag", "DesktopTagInUse", "UnknownHypervisorConnection", "UnknownPowerTimeScheme", "UnknownDumScheme", "UnknownPowerAction", "UnknownSession", "UnknownConfigurationSlot", "UnknownRebootSchedule", "LACNotFound", "HypervisorConnectionObjectNotFound", "PathNotFound", "DriveNotFound", "IdentityPoolOUInvalid", "ProvisioningSchemeNotFound", "IdentityPoolObjectNotFound", "HostingUnitNotFound", "AppDNASolutionNotFound", "BrokerMachineNotFound", "MCSDiskCopyTaskNotFound", "AppDiskNotFound", "AppDNAOperatingSystemNotFound", "MultipleRelationshipsSpecified", "NoRelationshipSpecified", "NoMatchingItems", "InvalidTimeZone", "InvalidScheduleStartTime", "InvalidStatusUpdatingFTA", "UserAccountRequired", "MustSupplyNameOrSID", "MustNotSupplyBothNameAndSID", "ConstraintViolation", "UnsupportedWildcard", "InvalidSecurityIdentifier", "InvalidIconData", "PvsForVMInvalid", "PvsDetailsRequired", "PvsDetailsInvalid", "MachinesArePhysicalRequired", "MachinesArePhysicalConflict", "MissingHostingData", "SuperfluousHostingData", "MultiSessionPoolManagementNotSupported", "MultipleUserAssignments", "MultipleDesktopAssignments", "PolicyRuleAppliedToMultipleApps", "ImportedFTACorrupted", "PowerTimeSchemeDaysOverlap", "SidMissingForEvictScript", "SidSuppliedForNonEvictScript", "MachineHypMcIdAlone", "InvalidRebootScheduleDay", "InvalidCommandRecipient", "InvalidAccount", "LACNotSupported", "WebkeyNotSupported", "InvalidLicenseFile", "EmptyLicenseFile", "InvalidLicenseFileExtension", "PollingIntervalMoreThanMaxValue", "PollingIntervalLessThanMinValue", "RetentionPeriodLessThanMinValue", "InvalidStartDateOrEndDate", "InvalidProductEditionModelFormat", "InvalidCEIPOption", "IdentityPoolOUOfWrongDomain", "NamingSchemeHasMoreThanOneSetOfHashes", "NamingSchemeIllegalCharacter", "NamingSchemeIllegalComputerName", "NamingSchemeMayNotBeAllNumbers", "NamingSchemeMayNotStartWithPeriod", "NamingSchemeMissingNumericSpecifications", "NamingSchemeNotEnoughCharacters", "NamingSchemeTooManyCharacters", "NamingSchemeUnicodeCharactersNotEnabled", "MCSCopyFailureInvalidVirtualDiskId", "InvalidMachineId", "DuplicateAppDisplayName", "DuplicateAppBrowserName", "DuplicateAdministrator", "DuplicateRebootSchedule", "DuplicateObject", "AdminAlreadyExists", "RoleAlreadyExists", "ScopeAlreadyExists", "HostingUnitDuplicateObjectExists", "ProvisioningSchemeNameAlreadyExists", "IdentityPoolDuplicateObjectExists", "AppDiskNameAlreadyExists", "DuplicateAutoscaleGroupPluginName", "CommunicationError", "NoServerErrorId", "InvalidServerPortString", "InvalidPortNumber", "InvalidServerGuid", "InvalidServerVersion", "ServerTimeout", "InvalidIPAddress", "NoSuitableServiceInstanceErrorId", "CommunicationsError", "CitrixLicensingVendorOrServiceDown", "CanNotImportStartUpLic", "CommunicationSecurityError", "InvalidArgument", "UpdateCacheInvalidArgument", "DataStoreException", "UnknownOperation", "DataStoreAlreadyConfigured", "MachineNotRegistered", "PowerManagedController", "DesktopGroupInUse", "MachineInUse", "CatalogInUse", "ApplicationInUse", "MachineAlreadyAllocated", "MachineNotInDesktopGroup", "MachineInDesktopGroup", "IncompatibleMachine", "IncompatibleDesktopUsage", "IncompatibleDesktopAssignment", "IncompatibleDesktopGroup", "IncompatibleCatalog", "DesktopAssigned", "InMaintenanceMode", "GroupInMaintenanceMode", "IconInUse", "NoAvailableMachine", "PowerTimeSchemeInUse", "IncompatibleDumScheme", "HypervisorInMaintenanceMode", "PowerActionsNotSupported", "PowerActionInProgress", "PowerActionComplete", "PowerActionIgnored", "PowerActionNotStarted", "ServiceGroupNotAllowed", "MachineConfigurationInUse", "NoEntitlements", "LastFullAdmin", "HypervisorConnectionForHostingUnitIsVirtual", "HostingUnitNetworkPathInvalid", "HostingUnitRootPathInvalid", "HostingUnitStoragePathInvalid", "InvalidHypervisorItem", "VMAlreadyUnlocked", "AppDiskInUse", "TaskActive", "AppDiskAlreadySealed", "AppVPackageImportError", "NoRemainingDeliveryGroups", "NameResolutionFailure", "HypervisorAddressInvalidFormat", "HypervisorPermissionDenied", "SCVMMConsoleNotInstalled", "ConnectionNotVCenter", "ConnectionExpiredCredentials", "ConnectionInvalidCredentials", "VCenterConnectionSslFailure", "XenServerConnectionSslFailure", "HypervisorNotContactable", "NoWorkspaceCloudConnectorFound", "WorkspaceCloudConnectorTimeout", "WorkspaceCloudConnectorEndpointNotFound", "VCenterHttpsConnectionRequiredForEndpoint", "MoonshotConnectionSslFailure", "MoonshotConnectionSslPrivateCASignedFailure", "MoonshotConnectionSslPublicCASignedFailure", "OpenShiftConnectionSslPublicCASignedFailure", "AWSAssumeRoleAuthenticationFailure", "AmuletHotkeyCoreStationConnectionSslFailure", "AmuletHotkeyCoreStationConnectionSslPrivateCASignedFailure", "AmuletHotkeyCoreStationConnectionSslPublicCASignedFailure" ] }, "JobResponseModel": { "title": "JobResponseModel", "type": "object", "description": "Response object indicating status of an asynchronous job.", "additionalProperties": false, "required": [ "Id", "Type", "Parameters", "Status", "CreationTime", "FormattedCreationTime" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the job in progress.", "minLength": 1 }, "Type": { "description": "Type of job that is being performed.", "$ref": "#/components/schemas/JobType" }, "OverallProgressPercent": { "title": "Int32", "type": "integer", "description": "Overall progress percent; 0..100.\nMay be null if the job does not support progress reporting.", "format": "int32", "nullable": true }, "IsCancellable": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the job may be cancelled.\nDeleteJob", "nullable": true }, "Parameters": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Indicators to the caller about what object(s) the job\nis affecting. Consult the documentation for APIs that\ninitiate jobs to see the properties expected to be present.", "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "SubJobs": { "title": "JobResponseModel[]", "type": "array", "description": "List of sub-jobs contained within the job.", "nullable": true, "items": { "$ref": "#/components/schemas/JobResponseModel" } }, "Status": { "description": "State of the job or subjob.", "$ref": "#/components/schemas/JobStatus" }, "ResultLocation": { "title": "String", "type": "string", "description": "URL where the job results can be obtained.", "nullable": true }, "ErrorString": { "title": "String", "type": "string", "description": "If a job or subjob failed, this will be the reason why\nthe failure occurred, presented in a human-readable\nformat.", "nullable": true }, "ErrorCode": { "description": "If a job or subjob failed, this will be the reason why\nthe failure occurred.", "nullable": true, "$ref": "#/components/schemas/JobErrorCode" }, "ErrorParameters": { "title": "NameValueStringPairModel[]", "type": "array", "description": "If a job or subjob failed, this will be information\nabout related objects that were involved in the\nfailure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "CreationTime": { "title": "String", "type": "string", "description": "Time when the job was created.", "minLength": 1 }, "FormattedCreationTime": { "title": "String", "type": "string", "description": "Formatted time when the job was created.\nRFC 3339 compatible format.", "minLength": 1 }, "StartTime": { "title": "String", "type": "string", "description": "Time when the job was started.\nWill be null if the job has not yet started.", "nullable": true }, "FormattedStartTime": { "title": "String", "type": "string", "description": "Formatted time when the job was started.\nWill be null if the job has not yet started.\nRFC 3339 compatible format.", "nullable": true }, "EndTime": { "title": "String", "type": "string", "description": "Time when the job was completed.\nWill be null if the job has not yet completed.", "nullable": true }, "FormattedEndTime": { "title": "String", "type": "string", "description": "Formatted time when the job was completed.\nWill be null if the job has not yet completed.\nRFC 3339 compatible format.", "nullable": true } } }, "JobResponseModelCollection": { "title": "JobResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfJobResponseModel" }, { "type": "object", "description": "JobResponseModel collection", "additionalProperties": false } ] }, "JobStatus": { "title": "JobStatus", "type": "string", "description": "Status of a job.", "x-enumNames": [ "Unknown", "NotStarted", "InProgress", "Complete", "CompleteWithWarning", "Failed", "Canceled", "NonTerminatingError" ], "enum": [ "Unknown", "NotStarted", "InProgress", "Complete", "CompleteWithWarning", "Failed", "Canceled", "NonTerminatingError" ] }, "JobType": { "title": "JobType", "type": "string", "description": "Types of long-running jobs that may be executing.", "x-enumNames": [ "Unknown", "Batch", "CreateDeliveryGroup", "UpdateDeliveryGroup", "DeleteDeliveryGroup", "AddDeliveryGroupMachines", "RemoveDeliveryGroupMachines", "AddDeliveryGroupApplications", "RemoveDeliveryGroupApplications", "RemoveDeliveryGroupApplicationGroups", "GetAdminFolders", "GetApplicationFolders", "GetAdminFolderApplications", "GetAdminFolderMachineCatalogs", "GetApplicationFolderApplications", "GetApplications", "GetApplicationSessions", "GetDeliveryGroups", "SearchApplications", "RefreshAppVApplications", "TestDeliveryGroup", "CreateTag", "UpdateTag", "DeleteTag", "AddIcon", "RemoveIcon", "SetTagApplications", "SetTagApplicationGroups", "SetTagDeliveryGroups", "SetTagDesktops", "SetTagMachineCatalogs", "SetTagMachines", "GetStartMenuApplications", "GetDeliveryGroupApplications", "GetDeliveryGroupsDesktops", "RebootMachines", "ShutDownMachines", "StartMachines", "SuspendMachines", "ResumeMachines", "CreateAdminFolder", "CreateApplicationFolder", "CreateRebootSchedule", "UpdateRebootSchedule", "DeleteRebootSchedule", "CreatePowerTimeScheme", "UpdatePowerTimeScheme", "DeletePowerTimeScheme", "CreateAdvancedAccessPolicy", "UpdateAdvancedAccessPolicy", "DeleteAdvancedAccessPolicy", "CreateResourceAccessPolicy", "UpdateResourceAccessPolicy", "DeleteResourceAccessPolicy", "AddMachineCatalogMachine", "UpdateMachineCatalogProvisioningScheme", "CreateMachineCatalog", "CreateMachineIdentity", "DeleteMachineIdentity", "UpdateMachineIdentity", "UpdateUserIdentity", "UpdateMachineCatalog", "DeleteMachineCatalog", "TestMachineCatalog", "LogoffSessions", "DisconnectSessions", "LogoffMachineSessions", "DeleteMachine", "SendSessionMessage", "AddApplications", "GetApplicationGroups", "GetApplicationGroup", "GetApplicationGroupApplications", "GetApplicationGroupDeliveryGroups", "CreateApplicationGroup", "DeleteApplication", "DeleteApplicationGroup", "SearchApplicationGroups", "DeleteAdminFolder", "DeleteApplicationFolder", "RemoveApplicationGroupApplications", "GetApplicationApplicationGroups", "GetApplicationDeliveryGroups", "UpdateApplication", "UpdateApplicationGroup", "UpdateAdminFolder", "UpdateApplicationFolder", "SearchStartMenuApplications", "ApplicationsDiscovery", "ModifyFTA", "ImportFTA", "GetSiteStatus", "TestSite", "CreateHypervisor", "CreateHypervisorResourcePool", "UpdateHypervisor", "UpdateHypervisorResourcePool", "HypervisorVmValidation", "TestHypervisor", "GetHypervisorOrphanedResources", "TestHypervisorResourcePool", "CreateStoreFrontServer", "DeleteStoreFrontServer", "UpdateStoreFrontServer", "UpdateImage", "SetProvScheme", "AddMachines", "UpdateMachineCatalogMachine", "RollbackMachineCatalogProvisioningScheme", "GetHypervisorResourcePool", "GetHypervisorsAndResourcePools", "GetHypervisorResourcePoolResources", "SearchHypervisorResourcePoolResources", "GetHypervisorAllResources", "SearchHypervisorAllResources", "GetHypervisorAllResourcesWithoutConnection", "SearchHypervisorAllResourcesWithoutConnection", "GetHypervisorResourcePools", "GetHypervisor", "GetHypervisors", "DeleteHypervisor", "DeleteResourcePool", "GetHypervisorSupportedPlugins", "GetHypervisorServerHAAddresses", "GetSessionApplications", "GetOperations", "DoOperationSearch", "FetchExistingOperationLabels", "ExportOperationReport", "DeleteAllOperations", "UpdateOperation", "NewOperation", "GetSessions", "DoSessionSearch", "GetMachines", "DoMachineSearch", "GetPvsSites", "GetPvsCollections", "GetPvsMachinesForCatalog", "GetMachineCatalogMachineAccounts", "GetMachineStartMenuShortcutIcon", "GetMachineCatalogs", "SearchMachineCatalogs", "GetMachineCatalogDetails", "GetAppVServers", "ImportAppVPackages", "AddAppVServer", "UpdateAppVServer", "RemoveAppVServer", "GetAppVPackages", "RemoveAppVPackage", "GetAppVIsolationGroups", "GetAppVPackageBrokerApplications", "GetAppVPackageDelveryGroups", "DeleteAppVIsolationGroup", "CreateAppVIsolationGroup", "UpdateAppVIsolationGroup", "GetAppVIsolationGroup", "GetApplicationFtas", "GetDeliveryGroupFtas", "GetAppVPackageApplicationFileTypes", "GetMachineCatalogMachines", "GetMachineCatalogDeliveryGroupAssociations", "DoDeliveryGroupSearch", "GetMachineCatalogLastMasterImage", "DoZoneSearch", "CreateZone", "EditZone", "DeleteZone", "AddItemsIntoZone", "MoveItemsIntoZone", "RemoveItemsFromZone", "StartDeliveryGroupRebootCycle", "GetAdminAdministrators", "CreateAdminScope", "DeleteAdminScope", "CreateAdminRole", "UpdateAdminRole", "DeleteAdminRole", "UpdateAdminScope", "SetBrokerHypervisorConnection", "ResetBrokerHypervisorConnection", "GetAllCatalogActions", "GetCatalogAction", "GetSingleCatalogAction", "CancelCatalogAction", "DeleteAllCatalogActions", "DeleteCatalogActions", "HideSession", "UnhideSession", "CreateMachineCatalogUpgradeSchedule", "RemoveMachineCatalogUpgradeSchedule", "UpdateMachineCatalogUpgradeSchedule", "GetVMConfigurationResultantSet", "ResetProvisionedVirtualMachineOSDisk", "GetHypervisorMachineCatalogs", "GetHypervisorResourcePoolMachineCatalogs", "GetHypervisorAdministrators", "GetHypervisorResourcePoolAdministrators", "CreateMachineUpgradeSchedule", "UpdateMachineUpgradeSchedule", "RemoveMachineUpgradeSchedule", "CreateMachinesUpgradeScheudle", "GetAppLibPackageDiscoveryProfiles", "GetAppLibPackageDiscoveryProfile", "CreateAppLibPackageDiscoveryProfile", "UpdateAppLibPackageDiscoveryProfile", "RemoveAppLibPackageDiscoveryProfile", "ValidateHypervisorResourcePoolResource", "CreateAppLibPackageDiscovery", "GetAppLibPackageDiscovery", "GetAppLibPackageDiscoveries", "SendCasEvent", "AddDeliveryGroupPolicySet", "RemoveDeliveryGroupPolicySet", "StartSessionRecording", "StopSessionRecording", "GetLicenseSummary", "GetDomainsIdentity", "GetForestsIdentity", "GetLicensePermission", "RemoveMachinePowerActionSchedule", "GetLicenseCertificate", "SetLicenseServer", "GetLicenseAlert", "AddLicense", "DeleteDeliveryController", "GenerateDeliveryControllerDeleteScript", "ChangeDatabase", "GetLicenseEntitlement", "AllocateLicense", "ValidateMachineCatalogVDAComponentsAndFeaturesSelection", "RemoveImageDefinition", "CreateImageVersion", "SetImageVersion", "DeleteImageVersion", "GetAllMachineIdentityPools", "GetAllMachineIdentityPool", "GetProvSchemeReferences", "RequestProvVmUpdate", "CreateAdmin", "UpdateAdmin", "DeleteAdmin", "GetBackups", "GetBackupHistory", "GetBackupMembers", "PinBackup", "GetPvsSite", "GetPvsVDisk", "GetPvsStore", "ResetVMDisk", "GetGpoPolicySets", "GetGpoPolicies", "GetGpoFilters", "GetGpoSettings", "RepairMachineCatalogAccounts", "ImportProvisionedVirtualMachines", "ValidateMachineCatalogCreation", "SearchProvisionedVirtualMachines", "GetProvisionedVirtualMachineDetails", "GetUsersIdentity", "GetPrintersIdentity", "GetServiceAccounts", "SearchProvisioningOperationEvent", "RemoveProvisioningOperationEvent", "ConfirmProvisioningOperationEvent", "TestServiceAccount", "GetSiteErrorWarning", "UpdateImageVersionResourcePools", "DoImageDefinitionAndImageVersionSearch", "CreateImageDefinition", "GetPatchPreviewServiceAccount", "GetHypervisorResourcePrices", "ValidateVDAComponentsAndFeaturesSelection", "UpdateProvisionedVirtualMachine", "GetTagsAssociatedWithDeliveryGroup", "GetTagsAssociatedWithEntitlementRule", "GetProvRecommendation", "GetHypervisorResourcePoolAllAvailableNetworks", "ApplyProvisionedVirtualMachineConfigurationUpdate", "GetAutoscalePluginTemplates", "GetAutoscalePluginTemplate", "NewAutoscalePluginTemplate", "UpdateAutoscalePluginTemplate", "DeleteAutoscalePluginTemplate", "GetDeliveryGroupAutoscaleGroupPlugins", "NewDeliveryGroupAutoscaleGroupPlugin", "UpdateDeliveryGroupAutoscaleGroupPlugin", "DeleteDeliveryGroupAutoscaleGroupPluginByUid", "GetMachineCatalogDailyCost", "GetMachineCatalogCostSummary", "GenerateAdvisorRecommendation", "SearchProvisioningScheme", "GroupMachine", "GetHypervisorAllResourcePools", "CreateServiceAccount", "SetServiceAccount", "SyncCloudConnectors", "TestMachine", "GetProvisioningSchemesDetails", "CreateProvisioningSchemeConfiguration", "RemoveProvisioningSchemeConfiguration", "CreateProvisionedVirtualMachineConfiguration", "RemoveProvisionedVirtualMachineConfiguration", "ScheduleProvisioningSchemeHardwareUpdate", "ScheduleProvisionedVirtualMachineHardwareUpdate", "CreateProvisionedVMConfigurationAndScheduleUpdate", "UpdateMachineCatalogPvsSchemeVDisk", "UpdateMachineCatalogPvsSchemeBdm", "IconDiscovery", "UpdateProvisionedBackup", "DeleteProvisionedBackup", "ScheduleTakeProvisionedBackup", "ScheduleRestoreToProvisionedBackup", "GetTasks", "DeleteTask", "CancelTask", "GetTaskDetails", "RestartTask", "UpdateTask", "ScheduleResetProvisionedVirtualMachineOSDisk", "GetTaskSubJobs", "SelectAllAction", "DoTaskSearch", "DoTaskSubJobSearch", "DoScheduleSearch", "DeleteSchedule", "ConfirmProvisioningSchemeOperationEvents", "ConfirmProvisionedVirtualMachineOperationEvents", "ScheduleProvisioningSchemeImageUpdate", "ConfirmProvisioningSchemeVirtualMachineOperationEvents" ], "enum": [ "Unknown", "Batch", "CreateDeliveryGroup", "UpdateDeliveryGroup", "DeleteDeliveryGroup", "AddDeliveryGroupMachines", "RemoveDeliveryGroupMachines", "AddDeliveryGroupApplications", "RemoveDeliveryGroupApplications", "RemoveDeliveryGroupApplicationGroups", "GetAdminFolders", "GetApplicationFolders", "GetAdminFolderApplications", "GetAdminFolderMachineCatalogs", "GetApplicationFolderApplications", "GetApplications", "GetApplicationSessions", "GetDeliveryGroups", "SearchApplications", "RefreshAppVApplications", "TestDeliveryGroup", "CreateTag", "UpdateTag", "DeleteTag", "AddIcon", "RemoveIcon", "SetTagApplications", "SetTagApplicationGroups", "SetTagDeliveryGroups", "SetTagDesktops", "SetTagMachineCatalogs", "SetTagMachines", "GetStartMenuApplications", "GetDeliveryGroupApplications", "GetDeliveryGroupsDesktops", "RebootMachines", "ShutDownMachines", "StartMachines", "SuspendMachines", "ResumeMachines", "CreateAdminFolder", "CreateApplicationFolder", "CreateRebootSchedule", "UpdateRebootSchedule", "DeleteRebootSchedule", "CreatePowerTimeScheme", "UpdatePowerTimeScheme", "DeletePowerTimeScheme", "CreateAdvancedAccessPolicy", "UpdateAdvancedAccessPolicy", "DeleteAdvancedAccessPolicy", "CreateResourceAccessPolicy", "UpdateResourceAccessPolicy", "DeleteResourceAccessPolicy", "AddMachineCatalogMachine", "UpdateMachineCatalogProvisioningScheme", "CreateMachineCatalog", "CreateMachineIdentity", "DeleteMachineIdentity", "UpdateMachineIdentity", "UpdateUserIdentity", "UpdateMachineCatalog", "DeleteMachineCatalog", "TestMachineCatalog", "LogoffSessions", "DisconnectSessions", "LogoffMachineSessions", "DeleteMachine", "SendSessionMessage", "AddApplications", "GetApplicationGroups", "GetApplicationGroup", "GetApplicationGroupApplications", "GetApplicationGroupDeliveryGroups", "CreateApplicationGroup", "DeleteApplication", "DeleteApplicationGroup", "SearchApplicationGroups", "DeleteAdminFolder", "DeleteApplicationFolder", "RemoveApplicationGroupApplications", "GetApplicationApplicationGroups", "GetApplicationDeliveryGroups", "UpdateApplication", "UpdateApplicationGroup", "UpdateAdminFolder", "UpdateApplicationFolder", "SearchStartMenuApplications", "ApplicationsDiscovery", "ModifyFTA", "ImportFTA", "GetSiteStatus", "TestSite", "CreateHypervisor", "CreateHypervisorResourcePool", "UpdateHypervisor", "UpdateHypervisorResourcePool", "HypervisorVmValidation", "TestHypervisor", "GetHypervisorOrphanedResources", "TestHypervisorResourcePool", "CreateStoreFrontServer", "DeleteStoreFrontServer", "UpdateStoreFrontServer", "UpdateImage", "SetProvScheme", "AddMachines", "UpdateMachineCatalogMachine", "RollbackMachineCatalogProvisioningScheme", "GetHypervisorResourcePool", "GetHypervisorsAndResourcePools", "GetHypervisorResourcePoolResources", "SearchHypervisorResourcePoolResources", "GetHypervisorAllResources", "SearchHypervisorAllResources", "GetHypervisorAllResourcesWithoutConnection", "SearchHypervisorAllResourcesWithoutConnection", "GetHypervisorResourcePools", "GetHypervisor", "GetHypervisors", "DeleteHypervisor", "DeleteResourcePool", "GetHypervisorSupportedPlugins", "GetHypervisorServerHAAddresses", "GetSessionApplications", "GetOperations", "DoOperationSearch", "FetchExistingOperationLabels", "ExportOperationReport", "DeleteAllOperations", "UpdateOperation", "NewOperation", "GetSessions", "DoSessionSearch", "GetMachines", "DoMachineSearch", "GetPvsSites", "GetPvsCollections", "GetPvsMachinesForCatalog", "GetMachineCatalogMachineAccounts", "GetMachineStartMenuShortcutIcon", "GetMachineCatalogs", "SearchMachineCatalogs", "GetMachineCatalogDetails", "GetAppVServers", "ImportAppVPackages", "AddAppVServer", "UpdateAppVServer", "RemoveAppVServer", "GetAppVPackages", "RemoveAppVPackage", "GetAppVIsolationGroups", "GetAppVPackageBrokerApplications", "GetAppVPackageDelveryGroups", "DeleteAppVIsolationGroup", "CreateAppVIsolationGroup", "UpdateAppVIsolationGroup", "GetAppVIsolationGroup", "GetApplicationFtas", "GetDeliveryGroupFtas", "GetAppVPackageApplicationFileTypes", "GetMachineCatalogMachines", "GetMachineCatalogDeliveryGroupAssociations", "DoDeliveryGroupSearch", "GetMachineCatalogLastMasterImage", "DoZoneSearch", "CreateZone", "EditZone", "DeleteZone", "AddItemsIntoZone", "MoveItemsIntoZone", "RemoveItemsFromZone", "StartDeliveryGroupRebootCycle", "GetAdminAdministrators", "CreateAdminScope", "DeleteAdminScope", "CreateAdminRole", "UpdateAdminRole", "DeleteAdminRole", "UpdateAdminScope", "SetBrokerHypervisorConnection", "ResetBrokerHypervisorConnection", "GetAllCatalogActions", "GetCatalogAction", "GetSingleCatalogAction", "CancelCatalogAction", "DeleteAllCatalogActions", "DeleteCatalogActions", "HideSession", "UnhideSession", "CreateMachineCatalogUpgradeSchedule", "RemoveMachineCatalogUpgradeSchedule", "UpdateMachineCatalogUpgradeSchedule", "GetVMConfigurationResultantSet", "ResetProvisionedVirtualMachineOSDisk", "GetHypervisorMachineCatalogs", "GetHypervisorResourcePoolMachineCatalogs", "GetHypervisorAdministrators", "GetHypervisorResourcePoolAdministrators", "CreateMachineUpgradeSchedule", "UpdateMachineUpgradeSchedule", "RemoveMachineUpgradeSchedule", "CreateMachinesUpgradeScheudle", "GetAppLibPackageDiscoveryProfiles", "GetAppLibPackageDiscoveryProfile", "CreateAppLibPackageDiscoveryProfile", "UpdateAppLibPackageDiscoveryProfile", "RemoveAppLibPackageDiscoveryProfile", "ValidateHypervisorResourcePoolResource", "CreateAppLibPackageDiscovery", "GetAppLibPackageDiscovery", "GetAppLibPackageDiscoveries", "SendCasEvent", "AddDeliveryGroupPolicySet", "RemoveDeliveryGroupPolicySet", "StartSessionRecording", "StopSessionRecording", "GetLicenseSummary", "GetDomainsIdentity", "GetForestsIdentity", "GetLicensePermission", "RemoveMachinePowerActionSchedule", "GetLicenseCertificate", "SetLicenseServer", "GetLicenseAlert", "AddLicense", "DeleteDeliveryController", "GenerateDeliveryControllerDeleteScript", "ChangeDatabase", "GetLicenseEntitlement", "AllocateLicense", "ValidateMachineCatalogVDAComponentsAndFeaturesSelection", "RemoveImageDefinition", "CreateImageVersion", "SetImageVersion", "DeleteImageVersion", "GetAllMachineIdentityPools", "GetAllMachineIdentityPool", "GetProvSchemeReferences", "RequestProvVmUpdate", "CreateAdmin", "UpdateAdmin", "DeleteAdmin", "GetBackups", "GetBackupHistory", "GetBackupMembers", "PinBackup", "GetPvsSite", "GetPvsVDisk", "GetPvsStore", "ResetVMDisk", "GetGpoPolicySets", "GetGpoPolicies", "GetGpoFilters", "GetGpoSettings", "RepairMachineCatalogAccounts", "ImportProvisionedVirtualMachines", "ValidateMachineCatalogCreation", "SearchProvisionedVirtualMachines", "GetProvisionedVirtualMachineDetails", "GetUsersIdentity", "GetPrintersIdentity", "GetServiceAccounts", "SearchProvisioningOperationEvent", "RemoveProvisioningOperationEvent", "ConfirmProvisioningOperationEvent", "TestServiceAccount", "GetSiteErrorWarning", "UpdateImageVersionResourcePools", "DoImageDefinitionAndImageVersionSearch", "CreateImageDefinition", "GetPatchPreviewServiceAccount", "GetHypervisorResourcePrices", "ValidateVDAComponentsAndFeaturesSelection", "UpdateProvisionedVirtualMachine", "GetTagsAssociatedWithDeliveryGroup", "GetTagsAssociatedWithEntitlementRule", "GetProvRecommendation", "GetHypervisorResourcePoolAllAvailableNetworks", "ApplyProvisionedVirtualMachineConfigurationUpdate", "GetAutoscalePluginTemplates", "GetAutoscalePluginTemplate", "NewAutoscalePluginTemplate", "UpdateAutoscalePluginTemplate", "DeleteAutoscalePluginTemplate", "GetDeliveryGroupAutoscaleGroupPlugins", "NewDeliveryGroupAutoscaleGroupPlugin", "UpdateDeliveryGroupAutoscaleGroupPlugin", "DeleteDeliveryGroupAutoscaleGroupPluginByUid", "GetMachineCatalogDailyCost", "GetMachineCatalogCostSummary", "GenerateAdvisorRecommendation", "SearchProvisioningScheme", "GroupMachine", "GetHypervisorAllResourcePools", "CreateServiceAccount", "SetServiceAccount", "SyncCloudConnectors", "TestMachine", "GetProvisioningSchemesDetails", "CreateProvisioningSchemeConfiguration", "RemoveProvisioningSchemeConfiguration", "CreateProvisionedVirtualMachineConfiguration", "RemoveProvisionedVirtualMachineConfiguration", "ScheduleProvisioningSchemeHardwareUpdate", "ScheduleProvisionedVirtualMachineHardwareUpdate", "CreateProvisionedVMConfigurationAndScheduleUpdate", "UpdateMachineCatalogPvsSchemeVDisk", "UpdateMachineCatalogPvsSchemeBdm", "IconDiscovery", "UpdateProvisionedBackup", "DeleteProvisionedBackup", "ScheduleTakeProvisionedBackup", "ScheduleRestoreToProvisionedBackup", "GetTasks", "DeleteTask", "CancelTask", "GetTaskDetails", "RestartTask", "UpdateTask", "ScheduleResetProvisionedVirtualMachineOSDisk", "GetTaskSubJobs", "SelectAllAction", "DoTaskSearch", "DoTaskSubJobSearch", "DoScheduleSearch", "DeleteSchedule", "ConfirmProvisioningSchemeOperationEvents", "ConfirmProvisionedVirtualMachineOperationEvents", "ScheduleProvisioningSchemeImageUpdate", "ConfirmProvisioningSchemeVirtualMachineOperationEvents" ] }, "LasActivationStatus": { "title": "LasActivationStatus", "type": "string", "description": "Type of DeliveryController state", "x-enumNames": [ "Activated", "NotActivated", "Expired", "Unknown" ], "enum": [ "Activated", "NotActivated", "Expired", "Unknown" ] }, "LeasingBehavior": { "title": "LeasingBehavior", "type": "string", "description": "Leasing behavior.", "x-enumNames": [ "Unknown", "Allowed", "Disallowed" ], "enum": [ "Unknown", "Allowed", "Disallowed" ] }, "LicenseAccessCodeRequestModel": { "title": "LicenseAccessCodeRequestModel", "type": "object", "description": "The request model for License Access Code", "additionalProperties": false, "required": [ "LicenseAccessCode" ], "properties": { "LicenseAccessCode": { "title": "String", "type": "string", "description": "The License Access Code provided by Citrix.", "minLength": 1 } } }, "LicenseCertificateResponseModel": { "title": "LicenseCertificateResponseModel", "type": "object", "description": "The https certificate of the license server", "additionalProperties": false, "properties": { "Thumbprint": { "title": "String", "type": "string", "description": "The thumbprint of the certificate", "nullable": true }, "Issuer": { "title": "String", "type": "string", "description": "The issuer of the certificate", "nullable": true }, "Subject": { "title": "String", "type": "string", "description": "The subject of the certificate", "nullable": true }, "ValidFrom": { "title": "String", "type": "string", "description": "Datetime the certificate valid from", "nullable": true }, "ValidTo": { "title": "String", "type": "string", "description": "Datetime the certificate valid to", "nullable": true }, "SerialNumber": { "title": "String", "type": "string", "description": "The serialNumber of the certificate", "nullable": true }, "FriendlyName": { "title": "String", "type": "string", "description": "The friendly name of the certificate", "nullable": true }, "Version": { "title": "Int32", "type": "integer", "description": "The certificate version", "format": "int32", "nullable": true }, "rawData": { "title": "String", "type": "string", "description": "The raw data for the entire X509v3 certificate as a hexadecimal string", "nullable": true }, "ChainStatusInformations": { "title": "String[]", "type": "array", "description": "A description of the ChainStatus value", "nullable": true, "items": { "title": "String", "type": "string" } }, "ChainStatusFlags": { "title": "X509ChainStatusFlags[]", "type": "array", "description": "The status of the X509 chain", "nullable": true, "items": { "$ref": "#/components/schemas/X509ChainStatusFlags" } } } }, "LicenseEntitlementRequestModel": { "title": "LicenseEntitlementRequestModel", "type": "object", "description": "Request model to download license based on license entitlement id", "additionalProperties": false, "required": [ "LicenseAccessCode", "Id" ], "properties": { "LicenseAccessCode": { "title": "String", "type": "string", "description": "The License Access Code provided by Citrix.", "minLength": 1 }, "Id": { "title": "String", "type": "string", "description": "License entitlement id", "minLength": 1 } } }, "LicenseEntitlementResponseModel": { "title": "LicenseEntitlementResponseModel", "type": "object", "description": "The response model for license entitlement when fetching license by License Access Code", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "The license entitlement id", "nullable": true }, "ProductName": { "title": "String", "type": "string", "description": "The product name of the license", "nullable": true }, "LicenseTotal": { "title": "Int32", "type": "integer", "description": "The total quantity of the license", "format": "int32" }, "LicenseAvailable": { "title": "Int32", "type": "integer", "description": "The quantity of the available license", "format": "int32" } } }, "LicenseEntitlementResponseModelCollection": { "title": "LicenseEntitlementResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfLicenseEntitlementResponseModel" }, { "type": "object", "description": "License entitlement response model collection", "additionalProperties": false } ] }, "LicenseErrorWarningModel": { "title": "LicenseErrorWarningModel", "allOf": [ { "$ref": "#/components/schemas/ErrorWarningModel" }, { "type": "object", "additionalProperties": false, "properties": { "NumberOfInfo": { "title": "Int32", "type": "integer", "description": "Count for info.", "format": "int32" } } } ] }, "LicenseInformationModel": { "title": "LicenseInformationModel", "type": "object", "description": "LicenseInformationModel", "additionalProperties": false, "properties": { "LicenseServerStatus": { "description": "License server status", "$ref": "#/components/schemas/LicenseServerStatus" }, "LicenseServerWslAddress": { "title": "String", "type": "string", "description": "The WSL Address of the license server, the format is https://[FQDN:Port]", "nullable": true }, "LicenseServerLicensingAddress": { "title": "String", "type": "string", "description": "The address of License Address", "nullable": true }, "LicenseServer": { "title": "String", "type": "string", "description": "The address of license server without the schema", "nullable": true }, "LicensePort": { "title": "Int32", "type": "integer", "description": "The port of license server", "format": "int32" }, "LicensingBurnInDate": { "title": "String", "type": "string", "description": "The subscription advantage date of the license", "nullable": true }, "LicenseProduct": { "description": "License product", "$ref": "#/components/schemas/LicenseProduct" }, "ProductEdition": { "description": "License edition", "$ref": "#/components/schemas/ProductEdition" }, "LicenseModel": { "description": "The license model", "$ref": "#/components/schemas/LicenseModel" }, "OutOfBoxGracePeriodActive": { "title": "Boolean", "type": "boolean", "description": "Indicate if trial license is used" }, "OutOfBoxGracePeriodHoursLeft": { "title": "Int32", "type": "integer", "description": "Indicate remaining hours for the trial period", "format": "int32", "nullable": true }, "UseLicenseActivationService": { "title": "Boolean", "type": "boolean", "description": "Indicate if License Activation Service is used", "nullable": true } } }, "LicenseInventoryModel": { "title": "LicenseInventoryModel", "type": "object", "description": "License Inventory Model", "additionalProperties": false, "properties": { "LicenseProductName": { "description": "The license name of the product", "$ref": "#/components/schemas/LicenseProduct" }, "LocalizedLicenseProductName": { "title": "String", "type": "string", "description": "Localized license name of the product", "nullable": true }, "LicenseExpirationDate": { "title": "String", "type": "string", "description": "The expired date of the license", "nullable": true }, "LicenseSubscriptionAdvantageDate": { "title": "String", "type": "string", "description": "The subscription advantage date of the license", "nullable": true }, "LicenseType": { "title": "String", "type": "string", "description": "The type of the license", "nullable": true }, "LicensesInUse": { "title": "Int32", "type": "integer", "description": "The number of the Licenses in use", "format": "int32" }, "LicensesAvailable": { "title": "Int32", "type": "integer", "description": "The number of the available licenses", "format": "int32" }, "LicenseOverdraft": { "title": "Int32", "type": "integer", "description": "The number of the overdraft licenses", "format": "int32" }, "LicenseModel": { "description": "The license model.", "$ref": "#/components/schemas/LicenseModel" }, "ProductEdition": { "description": "The product edition", "$ref": "#/components/schemas/ProductEdition" }, "LocalizedLicenseProductEdition": { "title": "String", "type": "string", "description": "Localized license name of the product edition", "nullable": true } } }, "LicenseModel": { "title": "LicenseModel", "type": "string", "description": "Types of license.", "x-enumNames": [ "Unknown", "None", "Concurrent", "UserDevice" ], "enum": [ "Unknown", "None", "Concurrent", "UserDevice" ] }, "LicensePermissionResponseModel": { "title": "LicensePermissionResponseModel", "type": "object", "description": "The permission to the license server", "additionalProperties": false, "properties": { "LicensingAdministrator": { "title": "String", "type": "string", "description": "The administrator for the license server", "nullable": true }, "LicensingPermissionLevel": { "description": "The permission level for the license server", "$ref": "#/components/schemas/LicensingPermissionLevel" } } }, "LicenseProduct": { "title": "LicenseProduct", "type": "string", "description": "License Product", "x-enumNames": [ "Unknown", "XenDesktopXds", "XenDesktopXdt", "XenDesktopXdtTP", "XenApp", "CVAP" ], "enum": [ "Unknown", "XenDesktopXds", "XenDesktopXdt", "XenDesktopXdtTP", "XenApp", "CVAP" ] }, "LicenseProductEditionResponseModel": { "title": "LicenseProductEditionResponseModel", "type": "object", "description": "The response object of license product edition.", "additionalProperties": false, "properties": { "LicenseProduct": { "description": "The product code.", "$ref": "#/components/schemas/LicenseProduct" }, "ProductEdition": { "description": "The product edition.", "$ref": "#/components/schemas/ProductEdition" }, "LicenseModel": { "description": "The license model.", "$ref": "#/components/schemas/LicenseModel" } } }, "LicenseRequestModel": { "title": "LicenseRequestModel", "type": "object", "description": "Request object for modification of the site license.", "additionalProperties": false, "properties": { "ProductCode": { "title": "String", "type": "string", "description": "The product code.", "nullable": true }, "ProductEdition": { "title": "String", "type": "string", "description": "The product edition.", "nullable": true }, "LicenseModel": { "description": "The license model.", "nullable": true, "$ref": "#/components/schemas/LicenseModel" } } }, "LicenseResponseModel": { "title": "LicenseResponseModel", "type": "object", "description": "Response object for the site license.", "additionalProperties": false, "required": [ "ProductCode", "ProductEdition", "LicenseModel" ], "properties": { "ProductCode": { "title": "String", "type": "string", "description": "The product code.", "minLength": 1 }, "ProductEdition": { "title": "String", "type": "string", "description": "The product edition.", "minLength": 1 }, "LicenseModel": { "description": "The license model.", "$ref": "#/components/schemas/LicenseModel" } } }, "LicenseResponseModelCollection": { "title": "LicenseResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfLicenseResponseModel" }, { "type": "object", "description": "License response model collection.", "additionalProperties": false } ] }, "LicenseServerStatus": { "title": "LicenseServerStatus", "type": "string", "description": "", "x-enumNames": [ "Compatible", "Incompatible", "Inaccessible", "InternalError", "LSVersionIncompatible", "CloudNotRegistered", "LasNotOnboarded", "InternetNotConnected", "LasCompatible", "NoInventory", "UnknownStatus" ], "enum": [ "Compatible", "Incompatible", "Inaccessible", "InternalError", "LSVersionIncompatible", "CloudNotRegistered", "LasNotOnboarded", "InternetNotConnected", "LasCompatible", "NoInventory", "UnknownStatus" ] }, "LicenseSummaryResponseModel": { "title": "LicenseSummaryResponseModel", "type": "object", "description": "Summary model", "additionalProperties": false, "properties": { "LicenseInformation": { "description": "Overview information of license server and current license.", "nullable": true, "$ref": "#/components/schemas/LicenseInformationModel" }, "LicenseInventories": { "title": "List`1", "type": "array", "description": "Get license inventory list", "nullable": true, "items": { "$ref": "#/components/schemas/LicenseInventoryModel" } }, "LicenseLasInventories": { "title": "List`1", "type": "array", "description": "Get license Las inventory list", "nullable": true, "items": { "$ref": "#/components/schemas/LicenseInventoryModel" } }, "NormalLicenses": { "title": "Int32", "type": "integer", "description": "The number of the available licenses", "format": "int32", "nullable": true }, "OverdraftLicenses": { "title": "Int32", "type": "integer", "description": "The number of the overdraft licenses", "format": "int32", "nullable": true }, "LicensesUsage": { "title": "Int32", "type": "integer", "description": "The usage of the licenses", "format": "int32", "nullable": true }, "CertAccepted": { "title": "Boolean", "type": "boolean", "description": "Indicates if the certificate is verified", "nullable": true } } }, "LicensingAlertLevel": { "title": "LicensingAlertLevel", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Info", "Alert", "Alarm" ], "enum": [ "Unknown", "Info", "Alert", "Alarm" ] }, "LicensingAlertLevel2": { "title": "LicensingAlertLevel", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Info", "Alert", "Alarm" ], "enum": [ "Unknown", "Info", "Alert", "Alarm" ] }, "LicensingAlertModel": { "title": "LicensingAlertModel", "type": "object", "description": "Licensing alert.", "additionalProperties": false, "properties": { "Priority": { "title": "Int32", "type": "integer", "description": "The priority of the licensing alert.", "format": "int32" }, "LicensingAlertLevel": { "description": "The alert level.", "$ref": "#/components/schemas/LicensingAlertLevel" }, "TypeCode": { "title": "String", "type": "string", "description": "The type code of the licensing alert (internal code used by licensing).", "nullable": true }, "Title": { "title": "String", "type": "string", "description": "The title of the alert.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "More detailed information about the licensing alert.", "nullable": true }, "Action": { "title": "String", "type": "string", "description": "The action the user should take to resolve the alert.", "nullable": true } } }, "LicensingAlertResponseModel": { "title": "LicensingAlertResponseModel", "type": "object", "description": "Licensing alert.", "additionalProperties": false, "properties": { "Priority": { "title": "Int32", "type": "integer", "description": "The priority of the licensing alert.", "format": "int32" }, "AlertLevel": { "description": "The alert level.", "$ref": "#/components/schemas/LicensingAlertLevel2" }, "TypeCode": { "title": "String", "type": "string", "description": "The type code of the licensing alert (internal code used by licensing).", "nullable": true }, "Title": { "title": "String", "type": "string", "description": "The title of the alert.", "nullable": true }, "Detail": { "title": "String", "type": "string", "description": "More detailed information about the licensing alert.", "nullable": true }, "Action": { "title": "String", "type": "string", "description": "The action the user should take to resolve the alert.", "nullable": true } } }, "LicensingPermissionLevel": { "title": "LicensingPermissionLevel", "type": "string", "description": "", "x-enumNames": [ "Unknown", "ReadOnly", "Full", "None" ], "enum": [ "Unknown", "ReadOnly", "Full", "None" ] }, "LicensingUserResponseModel": { "title": "LicensingUserResponseModel", "type": "object", "description": "Response object for the license administrator.", "additionalProperties": false, "properties": { "Account": { "title": "String", "type": "string", "description": "Gets or sets the account name", "nullable": true }, "AccountSid": { "title": "String", "type": "string", "description": "Gets or sets the account SID ", "nullable": true }, "PermissionLevel": { "description": "Gets or sets the permission level", "$ref": "#/components/schemas/LicensingPermissionLevel" }, "IsGroup": { "title": "Boolean", "type": "boolean", "description": "Gets or sets a value indicating whether it is an individual account or a group" } } }, "LicensingUserResponseModelCollection": { "title": "LicensingUserResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfLicensingUserResponseModel" }, { "type": "object", "description": "License response model collection.", "additionalProperties": false } ] }, "ListSortDirection": { "title": "ListSortDirection", "type": "string", "description": "Direction to sort the results.", "x-enumNames": [ "Ascending", "Descending" ], "enum": [ "Ascending", "Descending" ] }, "LoadBalanceType": { "title": "LoadBalanceType", "type": "string", "description": "Load Balance Type", "x-enumNames": [ "Unknown", "Vertical", "Horizontal", "None" ], "enum": [ "Unknown", "Vertical", "Horizontal", "None" ] }, "LogoffOption": { "title": "LogoffOption", "type": "string", "description": "Logoff options for VDA upgrade.\n ", "x-enumNames": [ "DoNotLogoff", "ActiveSessionsOnly", "DisconnectedSessionsOnly", "ActiveAndDisconnectedSessions" ], "enum": [ "DoNotLogoff", "ActiveSessionsOnly", "DisconnectedSessionsOnly", "ActiveAndDisconnectedSessions" ] }, "LogOperationResponseModel": { "title": "LogOperationResponseModel", "type": "object", "description": "Log operation response model.", "additionalProperties": false, "required": [ "Id", "Text", "Source", "StartTime", "FormattedStartTime", "TargetTypes", "OperationType", "Parameters" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the operation.", "minLength": 1 }, "Text": { "title": "String", "type": "string", "description": "Description of the operation.", "minLength": 1 }, "User": { "title": "String", "type": "string", "description": "User who performed the operation.", "nullable": true }, "UserIdentity": { "title": "String", "type": "string", "description": "The UserIdentity(Windows security identifier or Citrix Cloud Identity) of administrator who performed the operation.", "nullable": true }, "Source": { "title": "String", "type": "string", "description": "Source of the operation.", "minLength": 1 }, "AdminMachineIP": { "title": "String", "type": "string", "description": "IP address of the administrator's machine from which the operation was performed.", "nullable": true }, "EndTime": { "title": "String", "type": "string", "description": "Time when the operation ended.", "nullable": true }, "FormattedEndTime": { "title": "String", "type": "string", "description": "Formatted time when the operation ended.", "nullable": true }, "StartTime": { "title": "String", "type": "string", "description": "Time when the operation started.", "minLength": 1 }, "FormattedStartTime": { "title": "String", "type": "string", "description": "Formatted time when the operation started.", "minLength": 1 }, "IsSuccessful": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the operation completed successfully.", "nullable": true }, "TargetTypes": { "title": "String[]", "type": "array", "description": "Type of objects that were affected by the operation.", "items": { "title": "String", "type": "string" } }, "OperationType": { "description": "Type of the operation.", "$ref": "#/components/schemas/LogOperationType" }, "Labels": { "title": "String[]", "type": "array", "description": "Labels of the operation.", "nullable": true, "items": { "title": "String", "type": "string" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Metadata of the operation.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Parameters": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Parameters of the operation.", "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "LogOperationResponseModelCollection": { "title": "LogOperationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfLogOperationResponseModel" }, { "type": "object", "description": "Log operation response model collection", "additionalProperties": false } ] }, "LogOperationSearchFilterGroupRequestModel": { "title": "LogOperationSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for configuration logs.", "additionalProperties": false, "properties": { "SearchType": { "nullable": true, "$ref": "#/components/schemas/LogOperationSearchFilterGroupType" }, "SearchFilters": { "title": "LogOperationSearchFilterRequestModel[]", "type": "array", "description": "Advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/LogOperationSearchFilterRequestModel" } }, "SearchFilterGroups": { "title": "LogOperationSearchFilterGroupRequestModel[]", "type": "array", "description": "Advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/LogOperationSearchFilterGroupRequestModel" } } } }, "LogOperationSearchFilterGroupType": { "title": "LogOperationSearchFilterGroupType", "type": "string", "description": "The group type of advanced search filters for configuration logs.", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "LogOperationSearchFilterRequestModel": { "title": "LogOperationSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for configuration logs.", "additionalProperties": false, "required": [ "Property", "Value", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/LogOperationSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "minLength": 1 }, "Operator": { "description": "The comparison operator to use when determining if an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "LogOperationSearchProperty": { "title": "LogOperationSearchProperty", "type": "string", "description": "Configuration log operation properties that can be used for advanced search.", "x-enumNames": [ "Id", "Text", "User", "Source", "AdminMachineIP", "EndTime", "StartTime", "IsSuccessful", "TargetType", "OperationType", "Labels", "UserIdentity" ], "enum": [ "Id", "Text", "User", "Source", "AdminMachineIP", "EndTime", "StartTime", "IsSuccessful", "TargetType", "OperationType", "Labels", "UserIdentity" ] }, "LogOperationSearchRequestModel": { "title": "LogOperationSearchRequestModel", "type": "object", "description": "Request model for defining advanced configuration log search criteria.", "additionalProperties": false, "properties": { "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string.", "nullable": true }, "SearchType": { "nullable": true, "$ref": "#/components/schemas/LogOperationSearchFilterGroupType" }, "SearchFilters": { "title": "LogOperationSearchFilterRequestModel[]", "type": "array", "description": "Advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/LogOperationSearchFilterRequestModel" } }, "SearchFilterGroups": { "title": "LogOperationSearchFilterGroupRequestModel[]", "type": "array", "description": "Advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/LogOperationSearchFilterGroupRequestModel" } }, "SortCriteria": { "description": "Sort criteria for the results.", "nullable": true, "$ref": "#/components/schemas/LogOperationSortCriteriaRequestModel" } } }, "LogOperationSortCriteriaRequestModel": { "title": "LogOperationSortCriteriaRequestModel", "type": "object", "description": "Log operation sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/LogOperationSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "LogOperationType": { "title": "LogOperationType", "type": "string", "description": "Operation type for configuration log entries.", "x-enumNames": [ "Unknown", "ConfigurationChange", "AdminActivity" ], "enum": [ "Unknown", "ConfigurationChange", "AdminActivity" ] }, "LogSiteRequestModel": { "title": "LogSiteRequestModel", "type": "object", "description": "Set logging site model.", "additionalProperties": false, "properties": { "LoggingEnabled": { "title": "Boolean", "type": "boolean", "description": "Configuration logging settings enabled." }, "AllowChangesWhileDatabaseDown": { "title": "Boolean", "type": "boolean", "description": "Allow changes to the site configuration when the database is not available." }, "Locale": { "title": "String", "type": "string", "description": "Locale.", "nullable": true } } }, "LogSiteResponseModel": { "title": "LogSiteResponseModel", "type": "object", "description": "Logging site details model.", "additionalProperties": false, "properties": { "LoggingEnabled": { "title": "Boolean", "type": "boolean", "description": "Configuration logging settings enabled." }, "AllowChangesWhileDatabaseDown": { "title": "Boolean", "type": "boolean", "description": "Allow changes to the site configuration when the database is not available." }, "Locale": { "title": "String", "type": "string", "description": "Locale.", "nullable": true } } }, "LosingPolicy": { "title": "LosingPolicy", "type": "object", "description": "Policy that should be applied but not applied due to various reasons.", "additionalProperties": false, "properties": { "PolicyName": { "title": "String", "type": "string", "description": "Name of the policy.", "nullable": true }, "GpoName": { "title": "String", "type": "string", "description": "Name of the GPO that contains the policy that uses this setting.", "nullable": true }, "Reasons": { "title": "Dictionary`2", "type": "object", "description": "Reasons why the policy is not applied according to filtering results.", "nullable": true, "x-dictionaryKey": { "$ref": "#/components/schemas/ReasonStatus" }, "additionalProperties": { "title": "IEnumerable`1", "type": "array", "items": { "$ref": "#/components/schemas/ReasonDetail" } } }, "Priority": { "title": "Int32", "type": "integer", "description": "Policy priority.", "format": "int32" }, "WinningSettings": { "title": "WonOverBy[]", "type": "array", "description": "The settings in the policy and the reason of losing for each setting.", "nullable": true, "items": { "$ref": "#/components/schemas/WonOverBy" } } } }, "LosingPolicy2": { "title": "LosingPolicy", "type": "object", "description": "Policy that should be applied but not applied due to various reasons.", "additionalProperties": false, "properties": { "PolicyGuid": { "title": "Guid", "type": "string", "description": "Policy GUID.", "format": "guid" }, "PolicyName": { "title": "String", "type": "string", "description": "The policy name.", "nullable": true }, "Priority": { "title": "Int32", "type": "integer", "description": "Policy priority.", "format": "int32" }, "Settings": { "title": "WonOverBy[]", "type": "array", "description": "The settings in the policy and the reason of losing for each setting.", "nullable": true, "items": { "$ref": "#/components/schemas/WonOverBy2" } } } }, "LosingSetting": { "title": "LosingSetting", "type": "object", "description": "Setting that is not applied.", "additionalProperties": false, "properties": { "PolicyName": { "title": "String", "type": "string", "description": "Name of the policy.", "nullable": true }, "SettingName": { "title": "String", "type": "string", "description": "The setting that is not applied.", "nullable": true }, "GpoName": { "title": "String", "type": "string", "description": "Name of the GPO that contains the policy that uses this setting.", "nullable": true } } }, "LosingSetting2": { "title": "LosingSetting", "type": "object", "description": "Settings that are not applied.", "additionalProperties": false, "properties": { "PolicyGuid": { "title": "Guid", "type": "string", "description": "Policy GUID.", "format": "guid" }, "PolicyName": { "title": "String", "type": "string", "description": "The policy that has the setting.", "nullable": true }, "SettingName": { "title": "String", "type": "string", "description": "The setting that is not applied.", "nullable": true } } }, "LowLevelOperationDetailResponseModel": { "title": "LowLevelOperationDetailResponseModel", "type": "object", "description": "low level operation detail model\n ", "additionalProperties": false, "required": [ "StartTime", "FormattedStartTime", "TargetName", "TargetUid", "Text" ], "properties": { "EndTime": { "title": "String", "type": "string", "description": "The date and time that the operation completed.\nThis will be null if the operation is still in progress, or if the operation never completed.\n ", "nullable": true }, "FormattedEndTime": { "title": "String", "type": "string", "description": "The formatted date and time that the operation completed. RFC 3339 compatible format.\nThis will be null if the operation is still in progress, or if the operation never completed.\n ", "nullable": true }, "IsSuccessful": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the operation completed successfully or not.\nThis will be null if the operation is still in progress, or if the operation didn't complete.\n ", "nullable": true }, "NewValue": { "title": "String", "type": "string", "description": "The new property value.\n ", "nullable": true }, "PreviousValue": { "title": "String", "type": "string", "description": "The previous property value.\n ", "nullable": true }, "PropertyName": { "title": "String", "type": "string", "description": "The name of the changed property.\n ", "nullable": true }, "AddValue": { "title": "String", "type": "string", "description": "If the object property contains a set of values, this specifies the new value which was added to the set.\n ", "nullable": true }, "RemoveValue": { "title": "String", "type": "string", "description": "If the object property contains a set of values, this specifies the value which was removed from the set.\n ", "nullable": true }, "StartTime": { "title": "String", "type": "string", "description": "The date and time that the operation started.\n ", "minLength": 1 }, "FormattedStartTime": { "title": "String", "type": "string", "description": "The formatted date and time that the operation started. RFC 3339 compatible format.\n ", "minLength": 1 }, "TargetName": { "title": "String", "type": "string", "description": "The name of the target object affected by the operation.\n ", "minLength": 1 }, "TargetUid": { "title": "String", "type": "string", "description": "The unique identifier of the target object affected by the operation.\n ", "minLength": 1 }, "TargetType": { "title": "String", "type": "string", "description": "The type of the target object.\n ", "nullable": true }, "Text": { "title": "String", "type": "string", "description": "The description of operation performed on the target object.\n ", "minLength": 1 } } }, "LowLevelOperationResponseModel": { "title": "LowLevelOperationResponseModel", "type": "object", "description": "Low level operation response model\n ", "additionalProperties": false, "required": [ "Id", "OperationId", "OperationType", "Parameters", "Source", "StartTime", "FormattedStartTime", "TargetTypes", "Text" ], "properties": { "AdminMachineIP": { "title": "String", "type": "string", "description": "IP address of the admin machine from which the operation was performed.\n ", "nullable": true }, "Details": { "title": "LowLevelOperationDetailResponseModel[]", "type": "array", "description": "Details.\n ", "nullable": true, "items": { "$ref": "#/components/schemas/LowLevelOperationDetailResponseModel" } }, "EndTime": { "title": "String", "type": "string", "description": "Time when the operation ended.\nIf the operation is incomplete, will be null.\n ", "nullable": true }, "FormattedEndTime": { "title": "String", "type": "string", "description": "Formatted time when the operation ended. RFC 3339 compatible format.\nIf the operation is incomplete, will be null.\n ", "nullable": true }, "Id": { "title": "String", "type": "string", "description": "ID of the logged operation.\n ", "minLength": 1 }, "IsSuccessful": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the operation completed successfully. If the operation is\nincomplete, will be null.\n ", "nullable": true }, "OperationId": { "title": "String", "type": "string", "description": "The id of the (high level) operation.\n ", "minLength": 1 }, "OperationType": { "description": "Type of operation that was performed.\n ", "$ref": "#/components/schemas/LogOperationType" }, "Parameters": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Operation parameters.\n ", "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Source": { "title": "String", "type": "string", "description": "Source of the operation.\n ", "minLength": 1 }, "SourceSdk": { "title": "String", "type": "string", "description": "The source SDK.\n ", "nullable": true }, "StartTime": { "title": "String", "type": "string", "description": "Time when the operation started.\n ", "minLength": 1 }, "FormattedStartTime": { "title": "String", "type": "string", "description": "Formatted time when the operation started. RFC 3339 compatible format.\n ", "minLength": 1 }, "TargetTypes": { "title": "String[]", "type": "array", "description": "The type(s) of object which were the target of the configuration change. For\nexample, \"Session\" or \"Machine\".\n ", "items": { "title": "String", "type": "string" } }, "Text": { "title": "String", "type": "string", "description": "Human-readable description of the change.\n ", "minLength": 1 }, "User": { "title": "String", "type": "string", "description": "User who performed the change.\n ", "nullable": true }, "UserIdentity": { "title": "String", "type": "string", "description": "The identity (SID) of the user that performed the operation.\n ", "nullable": true } } }, "LowLevelOperationResponseModelCollection": { "title": "LowLevelOperationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfLowLevelOperationResponseModel" }, { "type": "object", "description": "Low level operation response model collection", "additionalProperties": false } ] }, "MachineAccountCreationRulesRequestModel": { "title": "MachineAccountCreationRulesRequestModel", "type": "object", "description": "Rules for creation of machine accounts in Active Directory.", "additionalProperties": false, "required": [ "NamingScheme", "Domain" ], "properties": { "NamingScheme": { "title": "String", "type": "string", "description": "Defines the template name for AD accounts created in the identity pool. Required.", "maxLength": 15, "minLength": 2, "pattern": "^(?=^.{2,15}$)(?=^[^\\\\\\/:\\*\\?\"<>|,~!@$%^&'`=+;.(){}_\\s]*$)(?=^[^\\.])(?=^.*[^\\d].*$).*(?|,~!@$%^&'(){}_\\s]*$).*$", "example": "For example, test.local" }, "NextValue": { "title": "String", "type": "string", "description": "Defines the next value that will be used if creating new AD accounts. Optional.", "maxLength": 15, "pattern": "^\\w+$", "nullable": true, "example": "For example, 5" }, "IdentityPoolId": { "title": "String", "type": "string", "description": "Existing identity pool id", "nullable": true } } }, "MachineAccountCreationRulesResponseModel": { "title": "MachineAccountCreationRulesResponseModel", "type": "object", "description": "Rules for creation of machine accounts in Active Directory.", "additionalProperties": false, "properties": { "NamingScheme": { "title": "String", "type": "string", "description": "The template name for AD accounts created in the identity pool.", "nullable": true }, "NamingSchemeType": { "description": "The type of naming scheme. This defines the format of the variable part of the AD account names that will be created.", "nullable": true, "$ref": "#/components/schemas/NamingSchemeType" }, "OU": { "title": "String", "type": "string", "description": "The OU that computer accounts will be created into.", "nullable": true }, "Domain": { "description": "The AD domain for the pool.", "nullable": true, "$ref": "#/components/schemas/IdentityDomainResponseModel" }, "NextValue": { "title": "String", "type": "string", "description": "The next value that will be used if creating new AD accounts.", "nullable": true } } }, "MachineAccountDeleteOption": { "title": "MachineAccountDeleteOption", "type": "string", "description": "Option for how to treat deleted machine accounts.", "x-enumNames": [ "Unknown", "Leave", "None", "Disable", "Delete" ], "enum": [ "Unknown", "Leave", "None", "Disable", "Delete" ] }, "MachineAccountRepairOption": { "title": "MachineAccountRepairOption", "type": "string", "description": "Option for how to repair machine accounts.", "x-enumNames": [ "Unknown", "UserCertificate", "IdentityInfo" ], "enum": [ "Unknown", "UserCertificate", "IdentityInfo" ] }, "MachineAccountRequestModel": { "title": "MachineAccountRequestModel", "type": "object", "description": "Active directory machine account which was externally created.", "additionalProperties": false, "required": [ "ADAccountName" ], "properties": { "ADAccountName": { "title": "String", "type": "string", "description": "The Active Directory account name to be imported.", "maxLength": 15, "minLength": 1, "pattern": ".*", "example": "For example, MyDomain\\MyComputer" }, "ResetPassword": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the machine account password should be reset.", "default": true, "nullable": true }, "Password": { "title": "String", "type": "string", "description": "The current password for the machine account , in the format specified by\nPasswordFormat.", "maxLength": 20480, "nullable": true, "example": "For example, password" }, "PasswordFormat": { "description": "The format of the machine account password.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" } } }, "MachineAgentOptions": { "title": "MachineAgentOptions", "type": "string", "description": "", "x-enumFlags": true, "x-enumNames": [ "None", "EnableAzureAdJoinAndDeviceEnrollment", "EnablePageFileSettingsCustomization" ], "enum": [ "None", "EnableAzureAdJoinAndDeviceEnrollment", "EnablePageFileSettingsCustomization" ] }, "MachineAndSessionSearchFilterGroupRequestModel": { "title": "MachineAndSessionSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for machines and sessions", "additionalProperties": false, "properties": { "SearchFilterGroupType": { "description": "The type of search filter group", "$ref": "#/components/schemas/MachineAndSessionSearchFilterGroupType" }, "SearchFilters": { "title": "MachineAndSessionSearchFilterRequestModel[]", "type": "array", "description": "The search filters in search filter group", "nullable": true, "items": { "$ref": "#/components/schemas/MachineAndSessionSearchFilterRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/MachineAndSessionSearchFilterGroupsType" }, "SearchFilterGroups": { "title": "MachineAndSessionSearchFilterGroupRequestModel[]", "type": "array", "description": "The search filter group in search filter groups", "nullable": true, "items": { "$ref": "#/components/schemas/MachineAndSessionSearchFilterGroupRequestModel" } } } }, "MachineAndSessionSearchFilterGroupsType": { "title": "MachineAndSessionSearchFilterGroupsType", "type": "string", "description": "The search filter groups type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "MachineAndSessionSearchFilterGroupType": { "title": "MachineAndSessionSearchFilterGroupType", "type": "string", "description": "The search filter group type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "MachineAndSessionSearchFilterRequestModel": { "title": "MachineAndSessionSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for machines.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/MachineAndSessionSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true, "example": "For example, test" }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "MachineAndSessionSearchProperty": { "title": "MachineAndSessionSearchProperty", "type": "string", "description": "Properties which can be used for advanced machine and session searches.\n\n Unsupported property when searching for machines :\n\n\n Unsupported properties when searching for sessions :\n ,,,,,,\n ,,,,,,,\n ,,,\n\n\n When searching for machines, the session properties cause a match if the\n machine is currently hosting a session that matches.\n\nWhen searching for sessions, the machine properties cause a match if the\nsession is hosted on a machine that matches.\n ", "x-enumNames": [ "AgentVersion", "AllocationType", "AppState", "AppsInUse", "AzureAdJoinedMode", "ControllerDnsName", "ClientIP", "ClientName", "CloudPCProvisioningType", "ConnectedViaHostName", "ConnectedViaIP", "HypervisorConnection", "ConnectionProtocol", "CurrentUser", "DeliveryGroup", "FaultState", "IsAssigned", "LastConnectionUser", "LastConnectionTime", "LastDeregistrationReason", "LastDeregistrationTime", "LaunchedViaHostName", "LaunchedViaIP", "PublishedName", "LoadIndex", "StartTime", "MachineCatalog", "MachineUnavailableReason", "InMaintenanceMode", "MaintenanceModeReason", "DrainingUntilShutdown", "MachineName", "OSType", "OSVersion", "ImageOutOfDate", "PowerActionPending", "ClientVersion", "PowerState", "SupportedPowerActions", "RegistrationState", "SecureIcaActive", "HostingServerName", "SessionCount", "SessionStateChangeTime", "SessionState", "SessionSupport", "SmartAccessFilters", "SummaryState", "Tags", "UserPrincipalName", "UserName", "UserDisplayName", "HostedMachineName", "WindowsConnectionSetting", "FunctionalLevel", "DnsName", "Uid", "Id", "VdaUpgrade", "VdaUpgradeState", "ProvisioningType", "ZoneName", "CriticalIssues", "NonCriticalIssues", "ProvisioningMaintenanceMode", "ConnectorId" ], "enum": [ "AgentVersion", "AllocationType", "AppState", "AppsInUse", "AzureAdJoinedMode", "ControllerDnsName", "ClientIP", "ClientName", "CloudPCProvisioningType", "ConnectedViaHostName", "ConnectedViaIP", "HypervisorConnection", "ConnectionProtocol", "CurrentUser", "DeliveryGroup", "FaultState", "IsAssigned", "LastConnectionUser", "LastConnectionTime", "LastDeregistrationReason", "LastDeregistrationTime", "LaunchedViaHostName", "LaunchedViaIP", "PublishedName", "LoadIndex", "StartTime", "MachineCatalog", "MachineUnavailableReason", "InMaintenanceMode", "MaintenanceModeReason", "DrainingUntilShutdown", "MachineName", "OSType", "OSVersion", "ImageOutOfDate", "PowerActionPending", "ClientVersion", "PowerState", "SupportedPowerActions", "RegistrationState", "SecureIcaActive", "HostingServerName", "SessionCount", "SessionStateChangeTime", "SessionState", "SessionSupport", "SmartAccessFilters", "SummaryState", "Tags", "UserPrincipalName", "UserName", "UserDisplayName", "HostedMachineName", "WindowsConnectionSetting", "FunctionalLevel", "DnsName", "Uid", "Id", "VdaUpgrade", "VdaUpgradeState", "ProvisioningType", "ZoneName", "CriticalIssues", "NonCriticalIssues", "ProvisioningMaintenanceMode", "ConnectorId" ] }, "MachineAndSessionSearchRequestModel": { "title": "MachineAndSessionSearchRequestModel", "type": "object", "description": "Request model for defining advanced machine and session search criteria.", "additionalProperties": false, "properties": { "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the machine.", "nullable": true, "example": "For example, name of a machine" }, "SearchFilters": { "title": "MachineAndSessionSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/MachineAndSessionSearchFilterRequestModel" } }, "SortCriteria": { "description": "Sort criteria for the results.", "nullable": true, "$ref": "#/components/schemas/MachineAndSessionSortCriteriaRequestModel" }, "SearchFilterGroups": { "title": "MachineAndSessionSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/MachineAndSessionSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/MachineAndSessionSearchFilterGroupsType" }, "SortCriteriaItems": { "title": "MachineAndSessionSortCriteriaRequestModel[]", "type": "array", "description": "Sort criteria for the results, multiple sorting criteria can be specified here.", "nullable": true, "items": { "$ref": "#/components/schemas/MachineAndSessionSortCriteriaRequestModel" } } } }, "MachineAndSessionSortCriteriaRequestModel": { "title": "MachineAndSessionSortCriteriaRequestModel", "type": "object", "description": "Machine sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/MachineAndSessionSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "MachineApplicationResponseModel": { "title": "MachineApplicationResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,ApplicationFolder,ApplicationType,PackagedApplicationType,PackagedApplicationVisibility,ClientFolder,Description,DoNotEnumerate,Enabled,IconId,ContentLocation,Name,PublishedName,Visible,SharingKind,ZoneId. \n Application published on, or in use on, a machine.\n ", "allOf": [ { "$ref": "#/components/schemas/ApplicationResponseModel" }, { "type": "object", "description": "Application published on, or in use on, a machine.", "additionalProperties": false, "properties": { "Published": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the application is published on the machine." }, "InUse": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the application is in use on the machine." } } } ] }, "MachineApplicationResponseModelCollection": { "title": "MachineApplicationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfMachineApplicationResponseModel" }, { "type": "object", "description": "Response object for collections of MachineApplicationResponseModel.", "additionalProperties": false } ] }, "MachineBaseResponseModel": { "title": "MachineBaseResponseModel", "type": "object", "description": "Default response field (Only return the fields specified there if supported in API ): Id,MachineCatalog,Name. ", "additionalProperties": false, "required": [ "Id" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of machine.", "minLength": 1 }, "MachineCatalog": { "description": "Machine catalog which the machine is a member of.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "Name": { "title": "String", "type": "string", "description": "DNS host name of the machine.\nUsed to be: MachineName", "nullable": true } } }, "MachineCatalogDeliveryGroupRefResponseModel": { "title": "MachineCatalogDeliveryGroupRefResponseModel", "allOf": [ { "$ref": "#/components/schemas/RefResponseModel" }, { "type": "object", "description": "Reference from a machine catalog to a delivery group.", "additionalProperties": false, "required": [ "NumAssigned", "Total" ], "properties": { "Priority": { "title": "Int32", "type": "integer", "description": "RemotePC machine allocation priority for delivery group.", "format": "int32", "nullable": true }, "NumAssigned": { "title": "Int32", "type": "integer", "description": "Number of machines assigned from the machine catalog into the delivery group.", "format": "int32" }, "Total": { "title": "Int32", "type": "integer", "description": "Total number of machines in the delivery group.", "format": "int32" } } } ] }, "MachineCatalogDetailResponseModel": { "title": "MachineCatalogDetailResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Name,FullName,Id,Uid,AllocationType,Description,IsPowerManaged,IsRemotePC,MachineType,MinimumFunctionalLevel,HasBeenPromoted,HasBeenPromotedFrom,PersistChanges,ProvisioningType,SessionSupport,SharingKind,Zone,AdminFolder,HypervisorVMTagging. \n Response object for machine catalog details.\n ", "allOf": [ { "$ref": "#/components/schemas/MachineCatalogResponseModel" }, { "type": "object", "description": "Response object for machine catalog details.", "additionalProperties": false, "required": [ "DeliveryGroups" ], "properties": { "AgentVersion": { "title": "String", "type": "string", "description": "Version of the Citrix Virtual Delivery Agent (VDA) installed on the machine.", "nullable": true }, "HypervisorConnection": { "description": "The hypervisor connection that is associated with the machines in the catalog.\nThis property only applies when ProvisioningType is\nMCS OR when\nIsRemotePC is `true` and\nthe Remote PCs are configured for power management via a hypervisor. For other\nprovisioning types, machines can be from one or more different hypervisor\nconnections.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "OSType": { "title": "String", "type": "string", "description": "A string that can be used to identify the operating system that\nis running on machines in the catalog.", "nullable": true }, "OSVersion": { "title": "String", "type": "string", "description": "A string that can be used to identify the version of the operating system running on the machine, if known.", "nullable": true }, "DeliveryGroups": { "title": "MachineCatalogDeliveryGroupRefResponseModel[]", "type": "array", "description": "Delivery groups associated with this catalog.", "items": { "$ref": "#/components/schemas/MachineCatalogDeliveryGroupRefResponseModel" } }, "UpgradeDetail": { "description": "Status detail of last VDA upgrade schedule for this machine catalog.", "nullable": true, "$ref": "#/components/schemas/MachineCatalogUpgradeDetail" } } } ] }, "MachineCatalogResponseModel": { "title": "MachineCatalogResponseModel", "type": "object", "description": "Default response field (Only return the fields specified there if supported in API ): Name,FullName,Id,Uid,AllocationType,Description,IsPowerManaged,IsRemotePC,MachineType,MinimumFunctionalLevel,HasBeenPromoted,HasBeenPromotedFrom,PersistChanges,ProvisioningType,SessionSupport,SharingKind,Zone,AdminFolder,HypervisorVMTagging. \n Response object for machine catalog.\n ", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Simple administrative name of catalog within parent admin folder (if any). This\nproperty is not guaranteed unique across all catalogs.", "nullable": true }, "FullName": { "title": "String", "type": "string", "description": "Unique administrative name of catalog.", "nullable": true }, "Id": { "title": "String", "type": "string", "description": "Id of the machine catalog.", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED. Use .` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use ." }, "AllocationType": { "description": "Denotes how the machines in the catalog are allocated to a user.", "$ref": "#/components/schemas/AllocationType" }, "AssignedCount": { "title": "Int32", "type": "integer", "description": "The number of assigned machines (machines that have been assigned to a user/users or a client name/address).", "format": "int32", "nullable": true }, "AvailableAssignedCount": { "title": "Int32", "type": "integer", "description": "The number of available machines (not in a delivery group), that are also assigned to users.", "format": "int32", "nullable": true }, "AvailableCount": { "title": "Int32", "type": "integer", "description": "The number of available machines (those not in any delivery group).", "format": "int32" }, "AvailableUnassignedCount": { "title": "Int32", "type": "integer", "description": "The number of available machines (those not in any delivery group) that are not assigned to users.", "format": "int32", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description of the machine catalog.", "nullable": true }, "IsPowerManaged": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the machines in the catalog are power-managed." }, "IsRemotePC": { "title": "Boolean", "type": "boolean", "description": "Indicates whether or not the catalog is a RemotePC catalog. Remote PC catalogs\nautomatically configure appropriate machines without the need for manual\nconfiguration.\nCHANGE: was\npublic bool RemotePC { get; set; }" }, "JobsInProgress": { "title": "RefResponseModel[]", "type": "array", "description": "List of jobs currently in progress that affect the machine catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "MachineType": { "description": "Type of the machines in the machine catalog.", "$ref": "#/components/schemas/MachineType" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of machine catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "MinimumFunctionalLevel": { "description": "The minimum functional level of machines in the machine catalog.", "$ref": "#/components/schemas/FunctionalLevel" }, "HasBeenPromoted": { "title": "Boolean", "type": "boolean", "description": "Whether the machine catalog was previously promoted from a lower\nMinimumFunctionalLevel." }, "HasBeenPromotedFrom": { "description": "If HasBeenPromoted is `true`, this is the\nprevious MinimumFunctionalLevel.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "CanRollbackVMImage": { "title": "Boolean", "type": "boolean", "description": "Whether the machine catalog can roll back VM image." }, "CanRecreateCatalog": { "title": "Boolean", "type": "boolean", "description": "Whether the machine catalog can recreate." }, "PersistChanges": { "description": "Specifies how user changes are persisted on machines in the machine catalog.", "$ref": "#/components/schemas/PersistChanges" }, "ProvisioningScheme": { "description": "Details about how machines in a catalog are provisioned.", "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeResponseModel" }, "ProvisioningType": { "description": "Specifies how the machines are provisioned in the catalog.", "$ref": "#/components/schemas/ProvisioningType" }, "ProvisioningProgress": { "description": "Specifies progress of provisioning for the machine catalog.", "nullable": true, "$ref": "#/components/schemas/ProvisioningProgressResponseModel" }, "PvsAddress": { "title": "String", "type": "string", "description": "IP address of the PVS server to be used.\nThis only applies if the ProvisioningType is\n.", "nullable": true }, "PvsDomain": { "title": "String", "type": "string", "description": "The domain of the PVS server to be used.", "nullable": true }, "RemotePCEnrollmentScopes": { "title": "RemotePCEnrollmentScopeResponseModel[]", "type": "array", "description": "List of one or more remote PC enrollment scopes.", "nullable": true, "items": { "$ref": "#/components/schemas/RemotePCEnrollmentScopeResponseModel" } }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "Administrative scopes which the machine catalog is part of.", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "Tenants": { "title": "RefResponseModel[]", "type": "array", "description": "The tenant(s) that the machine catalog is assigned to. If `null`,\nthe machine catalog is not assigned to tenants, and may be used by\nany tenant, including future added tenants.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "SessionSupport": { "description": "Specifies the session support of the machines in the machine catalog.", "$ref": "#/components/schemas/SessionSupport" }, "SharingKind": { "description": "Sharing mode for machines in the machine catalog.", "$ref": "#/components/schemas/SharingKind" }, "TotalCount": { "title": "Int32", "type": "integer", "description": "The total number of machines in the catalog.", "format": "int32" }, "IsBroken": { "title": "Boolean", "type": "boolean", "description": "Whether the machine catalog is currently in a \"Broken\" state." }, "IsMasterImageAssociated": { "title": "Boolean", "type": "boolean", "description": "Whether the machine catalog is associated with a master image.", "nullable": true }, "ImageUpdateStatus": { "description": "The machines image update status of a catalog", "$ref": "#/components/schemas/ImageUpdateStatus" }, "Errors": { "title": "String[]", "type": "array", "description": "Gets the Errors of machines in this catalog", "nullable": true, "items": { "title": "String", "type": "string" } }, "Warnings": { "title": "MachineCatalogWarningResponseModel[]", "type": "array", "description": "List of warnings that are currently active on the machine catalog,\nif any. If there are no warnings this will not be specified.", "nullable": true, "items": { "$ref": "#/components/schemas/MachineCatalogWarningResponseModel" } }, "UnassignedCount": { "title": "Int32", "type": "integer", "description": "The number of unassigned machines (machines not assigned to users).", "format": "int32" }, "UsedCount": { "title": "Int32", "type": "integer", "description": "The number of machines in the catalog that are in a delivery group.", "format": "int32" }, "AvailableCountOfSuspend": { "title": "Int32", "type": "integer", "description": "The number of available suspend-capable machines (those not in any delivery group).", "format": "int32", "nullable": true }, "AvailableAssignedCountOfSuspend": { "title": "Int32", "type": "integer", "description": "The number of available suspend-capable machines (not in a delivery group), that are also assigned to users.", "format": "int32", "nullable": true }, "UpgradeInfo": { "description": "VDA upgrade information the machine catalog is associated with.", "nullable": true, "$ref": "#/components/schemas/MachineCatalogUpgradeInfo" }, "Zone": { "description": "Zone the machine catalog is associated with.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "AdminFolder": { "description": "The folder in which the machinecatalog resides.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "HypervisorVMTagging": { "title": "Boolean", "type": "boolean", "description": "Indicates that assigned VMs from this catalog will carry a hypervisor-level tag.", "nullable": true }, "CriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "List of critical issues associated with the machine catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfCatalogErrorType" } }, "NonCriticalIssues": { "title": "CatalogIssueModel`1[]", "type": "array", "description": "List of non-critical issues associated with the machine catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/CatalogIssueModelOfMachineCatalogWarningType" } } } }, "MachineCatalogResponseModelCollection": { "title": "MachineCatalogResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfMachineCatalogResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "MachineCatalogTestResponseModel": { "title": "MachineCatalogTestResponseModel", "type": "object", "description": "Response object for a machine catalog test result.", "additionalProperties": false, "required": [ "MachineCatalog", "NumPassed", "NumWarnings", "NumFailures" ], "properties": { "MachineCatalog": { "description": "The machine catalog upon which the test was run.", "$ref": "#/components/schemas/RefResponseModel" }, "NumPassed": { "title": "Int32", "type": "integer", "description": "The number of tests that passed.", "format": "int32" }, "NumWarnings": { "title": "Int32", "type": "integer", "description": "The number of warnings that were found.", "format": "int32" }, "NumFailures": { "title": "Int32", "type": "integer", "description": "The number of tests that failed.", "format": "int32" }, "TestReport": { "description": "The detailed test report, only included when specifically requested in the API call.", "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } }, "MachineCatalogUpgradeDetail": { "title": "MachineCatalogUpgradeDetail", "type": "object", "description": "Status detail of last VDA upgrade schedule for a machine catalog.", "additionalProperties": false, "properties": { "ScheduleStatus": { "description": "State Id of this upgrade status object. Exact type TBD.", "$ref": "#/components/schemas/VdaUpgradeScheduleStatus" }, "LastStateChangeTimeUtc": { "title": "DateTime", "type": "string", "description": "UTC time when this upgrade status object changed status\nfor the last time.", "format": "date-time" }, "TotalMachines": { "title": "Int32", "type": "integer", "description": "Count of machines with an upgrade schedule in this catalog.\nThis does not always equal to the machine count of the catalog,\nas there might be machines which joined the catalog after a catalog\nlevel upgrade is scheduled, so do not have an upgrade status.", "format": "int32" }, "SuccessCount": { "title": "Int32", "type": "integer", "description": "Count of machines whose last upgrade is in success state.", "format": "int32" }, "ValidationFailureCount": { "title": "Int32", "type": "integer", "description": "Count of machines whose last upgrade failed during package validation.", "format": "int32" }, "InProgressCount": { "title": "Int32", "type": "integer", "description": "Count of machines whose upgrade is in progress.", "format": "int32" }, "UpgradeFailureCount": { "title": "Int32", "type": "integer", "description": "Count of machines whose last upgrade failed during package installation.", "format": "int32" }, "ScheduledTimeUtc": { "title": "DateTime", "type": "string", "description": "UTC time when this VDA upgrade was scheduled to start.", "format": "date-time" }, "DurationInHours": { "title": "Int32", "type": "integer", "description": "Timeout duration in hours, of the current VDA upgrade schedule.", "format": "int32" }, "TargetPackageVersion": { "title": "String", "type": "string", "description": "Target package version of the current VDA upgrade schedule.", "nullable": true }, "CancelledUpgradeCount": { "title": "Int32", "type": "integer", "description": "Count of machines whose last upgrade canceled during package installation.", "format": "int32" }, "WaitingToUpgradeCount": { "title": "Int32", "type": "integer", "description": "Count of machines who is waiting to upgrade.", "format": "int32" }, "AvailableForUpgradeCount": { "title": "Int32", "type": "integer", "description": "Count of machines who is available for upgrade.", "format": "int32", "nullable": true } } }, "MachineCatalogUpgradeInfo": { "title": "MachineCatalogUpgradeInfo", "type": "object", "description": "Machine catalog level VDA upgrade status info.\nThis is included in the machine catalog response model\nand used to render available upgrade options.", "additionalProperties": false, "properties": { "UpgradeType": { "description": "VDA upgrade type of this machine catalog.", "$ref": "#/components/schemas/VdaUpgradeType" }, "UpgradeState": { "description": "Upgrade state of the machine catalog.", "$ref": "#/components/schemas/VdaUpgradeState" }, "UpgradeScheduleStatus": { "description": "Status of current upgrade schedule associated with the machine catalog.", "$ref": "#/components/schemas/VdaUpgradeScheduleStatus" }, "UpgradeOngoingMachinesCount": { "title": "Int32", "type": "integer", "description": "Number of machines in the machine catalog with in-progress upgrades.", "format": "int32" }, "UpgradeFailedMachinesCount": { "title": "Int32", "type": "integer", "description": "Number of machines in the machine catalog with failed upgrades.", "format": "int32" } } }, "MachineCatalogValidationFailureModel": { "title": "MachineCatalogValidationFailureModel", "type": "object", "additionalProperties": false, "properties": { "ErrorId": { "title": "String", "type": "string", "description": "Gets or sets the lookup key (ErrorId) for this string.", "nullable": true }, "Category": { "title": "String", "type": "string", "description": "Gets or sets the category or label for the message.", "nullable": true }, "ErrorMessage": { "title": "String", "type": "string", "description": "Gets or sets the human-readable message for the message.", "nullable": true }, "Parameters": { "title": "IList`1", "type": "array", "description": "Gets or sets the parameters impacted by the validation failure.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "MachineCatalogValidationResponseModel": { "title": "MachineCatalogValidationResponseModel", "type": "object", "description": "Details about configuration validation during creating new machine catalog.", "additionalProperties": false, "required": [ "NumFailures", "ValidationFailures" ], "properties": { "NumFailures": { "title": "Int32", "type": "integer", "description": "The number failures of validation.", "format": "int32" }, "ValidationFailures": { "title": "MachineCatalogValidationFailureModel[]", "type": "array", "description": "The array of validation failures", "items": { "$ref": "#/components/schemas/MachineCatalogValidationFailureModel" } } } }, "MachineCatalogVusComponentResponseModel": { "title": "MachineCatalogVusComponentResponseModel", "type": "object", "description": "Response model of VDA upgrade components and features related to the Machine Catalog.", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "Uid": { "title": "Int32", "type": "integer", "description": "Uid of the catalog.", "format": "int32" }, "Id": { "title": "String", "type": "string", "description": "Id of the machine catalog.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the catalog.", "minLength": 1 }, "InstalledComponents": { "title": "VDAComponentModel[]", "type": "array", "description": "Installed VDA components of the catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAComponentModel" } }, "AvailableComponents": { "title": "VDAComponentModel[]", "type": "array", "description": "Available VDA components of the catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAComponentModel" } }, "AvailableFeatures": { "title": "VDAFeatureModel[]", "type": "array", "description": "Available VDA features of the catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAFeatureModel" } } } }, "MachineCatalogWarningResponseModel": { "title": "MachineCatalogWarningResponseModel", "type": "object", "description": "Describes a warning on a machine catalog.", "additionalProperties": false, "required": [ "Type" ], "properties": { "Type": { "description": "Type of warning.", "$ref": "#/components/schemas/MachineCatalogWarningType" }, "Subtype": { "description": "Sub-type of warning. For example, this might indicate why the\nwarning cannot be automatically corrected.", "nullable": true, "$ref": "#/components/schemas/MachineCatalogWarningSubtype" }, "Message": { "title": "String", "type": "string", "description": "Message associated with warning", "nullable": true } } }, "MachineCatalogWarningSubtype": { "title": "MachineCatalogWarningSubtype", "type": "string", "description": "Sub-types of warnings that may occur on a machine catalog.", "x-enumNames": [ "Unknown", "NoWarning", "NoPoweredOnVm", "LicensingTypeNotConfigured", "CheckNotSupported", "CheckNotCompleted", "CheckFailed", "NoNewRdsConnectionsAllowed", "OutOfGracePeriod", "PersonalTerminalServer", "RemoteDesktopForAdministration", "PerUserAllowed", "PerDeviceNoLicenseServer", "PerDeviceIncompatibleLicenseServer", "PerDeviceNoRequiredLicenseServer", "PerDeviceNoCalAndNoLicenseServer", "PerDeviceIssueMarkedTemporaryLicense", "PerDeviceUnmarkedTemporaryLicense", "PerDeviceUnexpiredTemporaryLicenseNotUpgraded", "PerDeviceUseUnexpiredUnmarkedTemporaryLicense", "PerDeviceExpiredTemporaryLicenseNotUpgraded", "PerDeviceExpiredUnmarkedTemporaryLicense", "MachineVdaUpgradeFailed", "AzureADJoinUnsupportedOsVersion", "HybridAzureADJoinUnsupportedOsVersion", "MicrosoftIntuneEnrollmentUnsupportedOsVersion" ], "enum": [ "Unknown", "NoWarning", "NoPoweredOnVm", "LicensingTypeNotConfigured", "CheckNotSupported", "CheckNotCompleted", "CheckFailed", "NoNewRdsConnectionsAllowed", "OutOfGracePeriod", "PersonalTerminalServer", "RemoteDesktopForAdministration", "PerUserAllowed", "PerDeviceNoLicenseServer", "PerDeviceIncompatibleLicenseServer", "PerDeviceNoRequiredLicenseServer", "PerDeviceNoCalAndNoLicenseServer", "PerDeviceIssueMarkedTemporaryLicense", "PerDeviceUnmarkedTemporaryLicense", "PerDeviceUnexpiredTemporaryLicenseNotUpgraded", "PerDeviceUseUnexpiredUnmarkedTemporaryLicense", "PerDeviceExpiredTemporaryLicenseNotUpgraded", "PerDeviceExpiredUnmarkedTemporaryLicense", "MachineVdaUpgradeFailed", "AzureADJoinUnsupportedOsVersion", "HybridAzureADJoinUnsupportedOsVersion", "MicrosoftIntuneEnrollmentUnsupportedOsVersion" ] }, "MachineCatalogWarningType": { "title": "MachineCatalogWarningType", "type": "string", "description": "Types of warnings that may occur on a machine catalog.", "x-enumNames": [ "Unknown", "RdsCatalogLicenseCheck", "ImagePreparationOfficeRearmCountExceeded", "ImagePreparationOfficeRearmFailed", "ImagePreparationOSRearmCountExceeded", "ImagePreparationOSRearmFailed", "CatalogAction", "GetCustomPropertiesFailed", "GetVMMetadataFailed", "ProvisionSchemeHasWarnings", "CertificateExpiring", "ServiceAccountHasWarnings", "NeitherAADDeviceManagementNorAADServiceAccountConfigured" ], "enum": [ "Unknown", "RdsCatalogLicenseCheck", "ImagePreparationOfficeRearmCountExceeded", "ImagePreparationOfficeRearmFailed", "ImagePreparationOSRearmCountExceeded", "ImagePreparationOSRearmFailed", "CatalogAction", "GetCustomPropertiesFailed", "GetVMMetadataFailed", "ProvisionSchemeHasWarnings", "CertificateExpiring", "ServiceAccountHasWarnings", "NeitherAADDeviceManagementNorAADServiceAccountConfigured" ] }, "MachineConfigurationResponseModel": { "title": "MachineConfigurationResponseModel", "type": "object", "description": "Machine Configuration response class.", "additionalProperties": false, "properties": { "Id": { "title": "Int32", "type": "integer", "description": "The Id of a machine configuration.", "format": "int32" }, "ConfigurationSlot": { "description": "The associated configuration slot.", "nullable": true, "$ref": "#/components/schemas/ConfigurationSlotResponseModel" }, "Name": { "title": "String", "type": "string", "description": "The name of a machine configuration.", "nullable": true }, "LeafName": { "title": "String", "type": "string", "description": "The name of a machine configuration.", "nullable": true }, "Policy": { "title": "String", "type": "string", "description": "The policy of a configuration slot.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The Description of a machine configuration.", "nullable": true }, "DeliveryGroups": { "title": "RefResponseModel[]", "type": "array", "description": "The associated desktop grouds ref.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } } } }, "MachineConfigurationResponseModelCollection": { "title": "MachineConfigurationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfMachineConfigurationResponseModel" }, { "type": "object", "description": "Collection of MachineConfigurationResponseModel", "additionalProperties": false } ] }, "MachineCriticalIssueType": { "title": "MachineCriticalIssueType", "type": "string", "description": "Machine error types.", "x-enumNames": [ "Unknown", "FailedToStart", "StuckOnBoot", "MaxCapacity", "AgentShutdown", "AgentSuspended", "IncompatibleVersion", "AgentNotContactable", "AgentAddressResolutionFailed", "AgentWrongActiveDirectoryOU", "EmptyRegistrationRequest", "MissingRegistrationCapabilities", "MissingAgentVersion", "InconsistentRegistrationCapabilities", "NotLicensedForFeature", "UnsupportedCredentialSecurityVersion", "InvalidRegistrationRequest", "SingleMultiSessionMismatch", "FunctionalLevelTooLowForCatalog", "FunctionalLevelTooLowForDesktopGroup", "PowerOff", "AgentRejectedSettingsUpdate", "SessionPrepareFailure", "ContactLost", "BrokerRegistrationLimitReached", "SettingsCreationFailure", "SendSettingsFailure", "UnexpectedAgentShutdown" ], "enum": [ "Unknown", "FailedToStart", "StuckOnBoot", "MaxCapacity", "AgentShutdown", "AgentSuspended", "IncompatibleVersion", "AgentNotContactable", "AgentAddressResolutionFailed", "AgentWrongActiveDirectoryOU", "EmptyRegistrationRequest", "MissingRegistrationCapabilities", "MissingAgentVersion", "InconsistentRegistrationCapabilities", "NotLicensedForFeature", "UnsupportedCredentialSecurityVersion", "InvalidRegistrationRequest", "SingleMultiSessionMismatch", "FunctionalLevelTooLowForCatalog", "FunctionalLevelTooLowForDesktopGroup", "PowerOff", "AgentRejectedSettingsUpdate", "SessionPrepareFailure", "ContactLost", "BrokerRegistrationLimitReached", "SettingsCreationFailure", "SendSettingsFailure", "UnexpectedAgentShutdown" ] }, "MachineDetailResponseModel": { "title": "MachineDetailResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Uid,AgentVersion,AllocationType,DeliveryGroup,DnsName,FunctionalLevel,InMaintenanceMode,MaintenanceModeReason,DrainingUntilShutdown,IPAddress,IsAssigned,MachineType,MachineUnavailableReason,OSType,OSVersion,PersistUserChanges,PowerActionPending,PowerState,ProvisioningType,PublishedName,RegistrationState,ScheduledReboot,Sid,SummaryState,WillShutdownAfterUse,SupportedPowerActions,FaultState,Id,MachineCatalog,Name. \n Response model for machine details.\n ", "allOf": [ { "$ref": "#/components/schemas/MachineResponseModel" }, { "type": "object", "description": "Response model for machine details.", "additionalProperties": false, "required": [ "IsReserved", "SessionsEstablished", "SessionsPending" ], "properties": { "AssignedClientName": { "title": "String", "type": "string", "description": "The name of the endpoint client device that the machine has\nbeen assigned to.", "nullable": true }, "AssignedIPAddress": { "title": "String", "type": "string", "description": "The IP address of the endpoint client device that the machine\nhas been assigned to.", "nullable": true }, "BrowserName": { "title": "String", "type": "string", "description": "Site-wide unique name identifying associated desktop to other components\n(for example StoreFront). This is typically non-null only for machines\nbacking assigned private desktops.", "nullable": true }, "ColorDepth": { "description": "The color depth setting configured on the machine.", "nullable": true, "$ref": "#/components/schemas/ColorDepth" }, "IsReserved": { "title": "Boolean", "type": "boolean", "description": "Indicates if machine is reserved for special use, for example for\nAppDisk preparation. A reserved machine cannot be a member of a\ndelivery group." }, "SecureIcaRequired": { "title": "Boolean", "type": "boolean", "description": "Flag indicating whether SecureICA is required or not when starting\na session on the machine.", "nullable": true }, "SessionsEstablished": { "title": "Int32", "type": "integer", "description": "Number of established sessions on this machine. When\nSessionSupport is equal to\nMultiSession, this excludes\nestablished sessions which have not yet completed their logon\nprocessing.", "format": "int32" }, "SessionsPending": { "title": "Int32", "type": "integer", "description": "Number of pending (brokered but not yet established) sessions\non this machine. When\nSessionSupport is equal to\nMultiSession, this also includes\nestablished sessions which have not yet completed their logon\nprocessing.", "format": "int32" }, "StoreFrontServersForHostedReceiver": { "title": "StoreFrontServerResponseModel[]", "type": "array", "description": "StoreFront servers to use for Receiver when it is hosted on\nthe machine.", "nullable": true, "items": { "$ref": "#/components/schemas/StoreFrontServerResponseModel" } }, "VMToolsState": { "description": "State of the hypervisor tools present on the VM (if any).", "nullable": true, "$ref": "#/components/schemas/VMToolsState" }, "FailureReason": { "title": "String", "type": "string", "description": "Failure reason of power action.", "nullable": true }, "FailedActionCompletionTime": { "title": "String", "type": "string", "description": "Time when the power action failed.", "nullable": true } } } ] }, "MachineGroupRequestModel": { "title": "MachineGroupRequestModel", "type": "object", "description": "Request model for defining group machine criteria.", "additionalProperties": false, "properties": { "SearchFilterGroups": { "title": "MachineAndSessionSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/MachineAndSessionSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/MachineAndSessionSearchFilterGroupsType" }, "MachinePropertyName": { "title": "String", "type": "string", "description": "The property name of the broker machine for grouping", "nullable": true } } }, "MachineHostingResponseModel": { "title": "MachineHostingResponseModel", "type": "object", "description": "Response model for machine hosting details.", "additionalProperties": false, "properties": { "HostedMachineId": { "title": "String", "type": "string", "description": "Unique ID within the hosting unit of the target managed machine.", "nullable": true }, "HostedMachineName": { "title": "String", "type": "string", "description": "The friendly name of a hosted machine as used by its hypervisor.\nThis is not necessarily the DNS name of the machine.", "nullable": true }, "HostingServerName": { "title": "String", "type": "string", "description": "DNS name of the hypervisor that is hosting the machine.", "nullable": true }, "LastHostingUpdateTime": { "title": "String", "type": "string", "description": "Time of last update to any hosting data (such as power\nstates) for this machine reported by the hypervisor\nconnection.", "nullable": true }, "FormattedLastHostingUpdateTime": { "title": "String", "type": "string", "description": "Formatted time of last update to any hosting data (such as power\nstates) for this machine reported by the hypervisor\nconnection.\nRFC 3339 compatible format.", "nullable": true }, "HypervisorConnection": { "description": "The hypervisor connection that the machine’s hosting server\nis accessed through.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "ImageOutOfDate": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the machine image matches the latest\nimage specified for the machine catalog." } } }, "MachineIdentityPoolResponseModel": { "title": "MachineIdentityPoolResponseModel", "type": "object", "description": "Details about machine identity pool response model.", "additionalProperties": false, "properties": { "Id": { "title": "Guid", "type": "string", "description": "Machine identity pool id.", "format": "guid" }, "Name": { "title": "String", "type": "string", "description": "Machine identity pool name.", "nullable": true }, "NamingSchemeType": { "description": "Machine identity pool nameing scheme type.", "$ref": "#/components/schemas/AccountNamingSchemeType" }, "NamingScheme": { "title": "String", "type": "string", "description": "Machine identity pool naming scheme.", "nullable": true }, "StartCount": { "title": "Int32", "type": "integer", "description": "Machine identity pool start count.", "format": "int32" }, "CustomActiveDirectoryOU": { "title": "String", "type": "string", "description": "Machine identity pool custom active directory OU.", "nullable": true }, "UseDefaultOU": { "title": "Boolean", "type": "boolean", "description": "Indicates whether use default OU" }, "DefaultOUDomain": { "description": "Default OU domain", "nullable": true, "$ref": "#/components/schemas/ADDomainResponseModel" }, "AvailableAccountsCount": { "title": "Int32", "type": "integer", "description": "The number of available accounts in the machine identity pool", "format": "int32" }, "InUseAccountsCount": { "title": "Int32", "type": "integer", "description": "The number of accounts in use in the machine identity pool", "format": "int32" }, "TaintedAccountsCount": { "title": "Int32", "type": "integer", "description": "The number of tainted accounts in the machine identity pool", "format": "int32" }, "ErrorAccountsCount": { "title": "Int32", "type": "integer", "description": "The number of bad accounts in the machine identity pool", "format": "int32" }, "TenantId": { "title": "Guid", "type": "string", "description": "Tenant id.", "format": "guid", "nullable": true }, "WorkGroupMachines": { "title": "Boolean", "type": "boolean", "description": "Work group machines." }, "IdentityType": { "title": "String", "type": "string", "description": "Identity type.", "nullable": true }, "IdentityContent": { "title": "String", "type": "string", "description": "Identity content.", "nullable": true }, "AzureADSecurityGroupName": { "title": "String", "type": "string", "description": "Microsoft Entra ID security group name.", "nullable": true }, "AzureADAccessToken": { "title": "String", "type": "string", "description": "Microsoft Entra access token.", "nullable": true }, "DeviceManagementType": { "title": "String", "type": "string", "description": "Device management type.", "nullable": true }, "AzureADTenantId": { "title": "Guid", "type": "string", "description": "Microsoft Entra tenant id.", "format": "guid", "nullable": true }, "ServiceAccountUid": { "title": "String[]", "type": "array", "description": "Service account Uids associated with this IdentityPool", "nullable": true, "items": { "title": "String", "type": "string" } }, "EntraIDExtensionAttributes": { "title": "Dictionary`2", "type": "object", "description": "The Microsoft Entra ID extension attributes that will be updated on Entra ID devices for the identities within the identity pool of this catalog.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } } } }, "MachineIdentityPoolResponseModelCollection": { "title": "MachineIdentityPoolResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfMachineIdentityPoolResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "MachineLogOnType": { "title": "MachineLogOnType", "type": "string", "description": "Data contract for MachineLogOnType.", "x-enumNames": [ "ActiveDirectory", "LocalMappedAccount", "AzureAD", "HybridAzureAD", "Unknown" ], "enum": [ "ActiveDirectory", "LocalMappedAccount", "AzureAD", "HybridAzureAD", "Unknown" ] }, "MachineNonCriticalIssueType": { "title": "MachineNonCriticalIssueType", "type": "string", "description": "Machine warning type.", "x-enumNames": [ "Unknown", "UnsupportedVdaVersion" ], "enum": [ "Unknown", "UnsupportedVdaVersion" ] }, "MachineProfileMetadataResponseModel": { "title": "MachineProfileMetadataResponseModel", "type": "object", "description": "The opaque VMMetadata response model", "additionalProperties": false, "properties": { "MachineSize": { "title": "String", "type": "string", "description": "VmMetadata machine size", "nullable": true }, "OsDiskCaching": { "title": "String", "type": "string", "description": "VmMetadata OS disk cache", "nullable": true }, "Tags": { "title": "String", "type": "string", "description": "VmMetadata tags", "nullable": true }, "BootDiagnostics": { "title": "Boolean", "type": "boolean", "description": "VmMetadata boot diagnostics configuration", "nullable": true }, "AcceleratedNetwork": { "title": "Boolean", "type": "boolean", "description": "VmMetadata accelerated network configuration", "nullable": true }, "SupportsHibernation": { "title": "Boolean", "type": "boolean", "description": "VmMetadata hibernation configuration.", "nullable": true }, "ZoneName": { "title": "String", "type": "string", "description": "VmMetadata zone name", "nullable": true }, "Labels": { "title": "String", "type": "string", "description": "VmMetadata labels", "nullable": true } } }, "MachineResponseModel": { "title": "MachineResponseModel", "description": "Default response field (Only return the fields specified there if supported in API ): Uid,AgentVersion,AllocationType,DeliveryGroup,DnsName,FunctionalLevel,InMaintenanceMode,MaintenanceModeReason,DrainingUntilShutdown,IPAddress,IsAssigned,MachineType,MachineUnavailableReason,OSType,OSVersion,PersistUserChanges,PowerActionPending,PowerState,ProvisioningType,PublishedName,RegistrationState,ScheduledReboot,Sid,SummaryState,WillShutdownAfterUse,SupportedPowerActions,FaultState,Id,MachineCatalog,Name. \n Response model for machine.\n ", "allOf": [ { "$ref": "#/components/schemas/MachineBaseResponseModel" }, { "type": "object", "description": "Response model for machine.", "additionalProperties": false, "properties": { "Uid": { "title": "Int32", "type": "integer", "description": "DEPRECATED. Use Id.\nUsed to be: DesktopUid", "format": "int32", "deprecated": true, "x-deprecatedMessage": "Should not use it.", "nullable": true }, "AgentVersion": { "title": "String", "type": "string", "description": "Version of the Citrix Virtual Delivery Agent (VDA) installed on the machine.", "nullable": true }, "AllocationType": { "description": "Describes how the machine is allocated to the user.", "$ref": "#/components/schemas/AllocationType" }, "ApplicationsInUse": { "title": "RefResponseModel[]", "type": "array", "description": "List of applications in use in the session.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "AssignedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "List of one or more users to whom the machine is assigned.\nOnly used when AllocationType\nis equal to Static.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "AssociatedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The current user(s) for shared machines and the assigned users for private machines.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "AzureAdJoinedMode": { "description": "The type of Microsoft Entra Domain join that took place in VDA.", "$ref": "#/components/schemas/AzureAdJoinedMode" }, "ContainerScopes": { "title": "ContainerScopeResponseModel[]", "type": "array", "description": "Delegated admin scopes in which the containers of the\nmachine reside.", "nullable": true, "items": { "$ref": "#/components/schemas/ContainerScopeResponseModel" } }, "ControllerDnsName": { "title": "String", "type": "string", "description": "The DNS host name of the controller that the machine is\nregistered to.", "nullable": true }, "DeliveryGroup": { "description": "Delivery group which the machine is a member of.\nMay be null if the machine is not a member of a\ndelivery group.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "DeliveryType": { "description": "Denotes the type(s) of published resources which the machine may deliver.", "nullable": true, "$ref": "#/components/schemas/DeliveryKind" }, "Description": { "title": "String", "type": "string", "description": "Description of the machine.", "nullable": true }, "DesktopConditions": { "title": "DesktopCondition[]", "type": "array", "description": "List of outstanding desktop conditions for the machine.", "nullable": true, "items": { "$ref": "#/components/schemas/DesktopCondition" } }, "DnsName": { "title": "String", "type": "string", "description": "The DNS host name of the machine.", "nullable": true }, "FunctionalLevel": { "description": "Functional level of the machine, if known.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "Hosting": { "description": "Details about the hosting of the machine, if the machine is hosted.", "nullable": true, "$ref": "#/components/schemas/MachineHostingResponseModel" }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Denotes if the machine is in maintenance mode.\nMachines in maintenance mode will not accept new sessions." }, "MaintenanceModeReason": { "description": "The reason why the machine was placed in maintenance mode (if it is in maintenance mode).Possible values are:\no None - Machine is not in maintenance mode.\\n\no Administrator - Machine was manually placed in maintenance mode by an administrator.\no MaxFailedRegistrations - Machine was automatically placed in\n maintenance mode due to reaching the maximum failed registration limit.", "$ref": "#/components/schemas/MaintenanceModeReason" }, "DrainingUntilShutdown": { "title": "Boolean", "type": "boolean", "description": "Denotes if the machine is placed to drain until shutdown" }, "IPAddress": { "title": "String", "type": "string", "description": "The IP address of the machine.", "nullable": true }, "IsAssigned": { "title": "Boolean", "type": "boolean", "description": "Denotes whether a private desktop has been assigned to a user/users,\nor a client name/address. Users can be assigned explicitly or by\nassigning on first use of the machine.\nOnly relevant for privately assigned machines.", "nullable": true }, "MachineType": { "description": "Type of machine.", "$ref": "#/components/schemas/MachineType" }, "LastConnectionFailure": { "description": "The reason for the last failed connection between a client and\nthe machine.", "nullable": true, "$ref": "#/components/schemas/ConnectionFailureReason" }, "LastConnectionTime": { "title": "String", "type": "string", "description": "Time of the last detected connection attempt that either failed or succeeded.", "nullable": true }, "FormattedLastConnectionTime": { "title": "String", "type": "string", "description": "Formatted time of the last detected connection attempt that either failed or succeeded.\nRFC 3339 compatible format.", "nullable": true }, "LastConnectionUser": { "description": "The user that last attempted a connection with the machine.", "nullable": true, "$ref": "#/components/schemas/IdentityUserResponseModel" }, "LastDeregistrationReason": { "description": "The reason for the last deregistration of the machine with\nthe broker.", "nullable": true, "$ref": "#/components/schemas/DeregistrationReason" }, "LastDeregistrationTime": { "title": "String", "type": "string", "description": "Time of the last deregistration of the machine from the controller.", "nullable": true }, "FormattedLastDeregistrationTime": { "title": "String", "type": "string", "description": "Formatted time of the last deregistration of the machine from the controller.\nRFC 3339 compatible format.", "nullable": true }, "LastErrorReason": { "title": "String", "type": "string", "description": "The reason for the last error detected in the machine.", "nullable": true }, "LastErrorTime": { "title": "String", "type": "string", "description": "The time of the last detected error.", "nullable": true }, "FormattedLastErrorTime": { "title": "String", "type": "string", "description": "The formatted time of the last detected error.\nRFC 3339 compatible format.", "nullable": true }, "LoadIndex": { "title": "Int32", "type": "integer", "description": "Gives current effective load index.\nOnly used when SessionSupport\nis equal to MultiSession.", "format": "int32", "nullable": true }, "LoadIndexes": { "title": "Int32[]", "type": "array", "description": "Gives the last reported individual load indexes that were used\nin the calculation of the LoadIndex value. Note that\nthe LoadIndex value may have been subsequently\nadjusted due to session brokering operations. This value is only\nset when SessionSupport\nis equal to MultiSession.", "nullable": true, "items": { "title": "Int32", "type": "integer", "format": "int32" } }, "LoadIndexNames": { "title": "String[]", "type": "array", "description": "Gives the last reported individual load index names that were used\nin the calculation of the LoadIndex value. Note that\nthe LoadIndex value may have been subsequently\nadjusted due to session brokering operations. This value is only\nset when SessionSupport\nis equal to MultiSession.", "nullable": true, "items": { "title": "String", "type": "string" } }, "MachineUnavailableReason": { "description": "Reason reported from the VDA showing why it is not yet available for use even though it is registered.", "$ref": "#/components/schemas/MachineUnavailableReason" }, "OSType": { "title": "String", "type": "string", "description": "A string that can be used to identify the operating system that is running on the machine.", "nullable": true }, "OSVersion": { "title": "String", "type": "string", "description": "A string that can be used to identify the version of the operating system running on the machine, if known.", "nullable": true }, "PersistUserChanges": { "description": "Describes if and how user changes are persisted.", "nullable": true, "$ref": "#/components/schemas/PersistChanges" }, "PowerActionPending": { "title": "Boolean", "type": "boolean", "description": "Indicates if there are any pending power actions for the machine.\nOnly relevant for power-managed machines.", "nullable": true }, "PowerState": { "description": "The current power state of the machine.", "$ref": "#/components/schemas/PowerState" }, "ProvisioningType": { "description": "Describes how the machine was provisioned.", "$ref": "#/components/schemas/ProvisioningType" }, "PublishedApplications": { "title": "String[]", "type": "array", "description": "Indicates the published applications.", "nullable": true, "items": { "title": "String", "type": "string" } }, "PublishedName": { "title": "String", "type": "string", "description": "The name of the machine that is displayed in Receiver, if the\nmachine has been published.", "nullable": true }, "RegistrationState": { "description": "Indicates the registration state of the machine.", "nullable": true, "$ref": "#/components/schemas/RegistrationState" }, "ScheduledReboot": { "description": "Indicates the state of any scheduled reboot operation for a machine.", "$ref": "#/components/schemas/ScheduledReboot" }, "SessionClientAddress": { "title": "String", "type": "string", "description": "The IP address of the client connected to the session.", "nullable": true }, "SessionClientName": { "title": "String", "type": "string", "description": "The host name of the client connected to the session.", "nullable": true }, "SessionClientVersion": { "title": "String", "type": "string", "description": "The version of the Citrix Receiver running on the client connected to the session.", "nullable": true }, "SessionConnectedViaHostName": { "title": "String", "type": "string", "description": "The host name of the incoming connection. This is usually a gateway, router or client.", "nullable": true }, "SessionConnectedViaIP": { "title": "String", "type": "string", "description": "The IP address of the incoming connection This is usually a gateway, router or client.", "nullable": true }, "SessionCount": { "title": "Int32", "type": "integer", "description": "Number of sessions running on the machine.", "format": "int32", "nullable": true }, "SessionLaunchedViaHostName": { "title": "String", "type": "string", "description": "The host name of the StoreFront server used to launch the session.", "nullable": true }, "SessionLaunchedViaIP": { "title": "String", "type": "string", "description": "The IP address of the StoreFront server used to launch the session.", "nullable": true }, "SessionProtocol": { "description": "The protocol that the session is using.", "nullable": true, "$ref": "#/components/schemas/ProtocolType" }, "SessionSecureIcaActive": { "title": "Boolean", "type": "boolean", "description": "Indicates whether SecureICA is active on the session.", "nullable": true }, "SessionSmartAccessTags": { "title": "String[]", "type": "array", "description": "The Smart Access tags for this session.", "nullable": true, "items": { "title": "String", "type": "string" } }, "SessionStartTime": { "title": "String", "type": "string", "description": "The time indicates when the session was started.", "nullable": true }, "FormattedSessionStartTime": { "title": "String", "type": "string", "description": "The formatted time indicates when the session was started.\nRFC 3339 compatible format.", "nullable": true }, "SessionState": { "description": "The state of the session.", "nullable": true, "$ref": "#/components/schemas/SessionState" }, "SessionStateChangeTime": { "title": "String", "type": "string", "description": "The time of the most recent state change for the session.", "nullable": true }, "FormattedSessionStateChangeTime": { "title": "String", "type": "string", "description": "The formatted time of the most recent state change for the session.\nRFC 3339 compatible format.", "nullable": true }, "SessionSupport": { "description": "Indicates the session support of the machine.", "$ref": "#/components/schemas/SessionSupport" }, "SessionUserName": { "title": "String", "type": "string", "description": "The session user name.", "nullable": true }, "Sid": { "title": "String", "type": "string", "description": "The SID of the machine.\nUsed to be: DesktopSid or SID (based on the context)", "nullable": true }, "SummaryState": { "description": "Indicates the overall state of the desktop associated with the machine. The overall state is a result of other more specific states such as session state, registration state and power state.", "$ref": "#/components/schemas/SummaryState" }, "WillShutdownAfterUse": { "title": "Boolean", "type": "boolean", "description": "Flag indicating if this machine is tainted and will be shut down\nafter all sessions on the machine have ended. This flag is only\never non-null on power-managed, single-session machines.", "nullable": true }, "WindowsConnectionSetting": { "description": "The logon mode reported by Windows itself (multi-session machines\nonly). For single-session machines the value is always hardwired\nto LogonEnabled.", "nullable": true, "$ref": "#/components/schemas/WindowsConnectionSetting" }, "WindowsActivationStatus": { "title": "String", "type": "string", "description": "Windows Activation Status of the provisioned virtual machine.\nThis is by default set to unknown and is updated when the vda registers with the DDC.", "nullable": true }, "WindowsActivationStatusErrorCode": { "title": "String", "type": "string", "description": "The default value is Unknown. If successful, it displays as Success, else it displays with the associated error code.", "nullable": true }, "WindowsActivationStatusVirtualMachineError": { "title": "String", "type": "string", "description": "Provides a detailed information of potential error message seen while activating the windows system.", "nullable": true }, "WindowsActivationTypeProvisionedVirtualMachine": { "title": "String", "type": "string", "description": "Windows Activation Type of the Provisioned Virtual Machine.\nThe default value is unknown and the field is populated once the virtual machine registers with DDC.\nThis is supported only on 2303 and successive versions.", "nullable": true }, "Zone": { "description": "The zone in which the machine is located.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "SupportedPowerActions": { "title": "SupportedPowerAction[]", "type": "array", "description": "A list of power actions supported by this machine.", "nullable": true, "items": { "$ref": "#/components/schemas/SupportedPowerAction" } }, "FaultState": { "description": "Summary state of any current fault state of the machine.", "$ref": "#/components/schemas/FaultState" }, "ContainerMetadata": { "description": "The metadata of Container.", "nullable": true, "$ref": "#/components/schemas/ContainerMetadataModel" }, "Tags": { "title": "String[]", "type": "array", "description": "The tags for this machine.", "nullable": true, "items": { "title": "String", "type": "string" } }, "UpgradeType": { "description": "VDA upgrade type of this machine.", "nullable": true, "$ref": "#/components/schemas/VdaUpgradeType" }, "UpgradeState": { "description": "Upgrade state of this machine.", "nullable": true, "$ref": "#/components/schemas/VdaUpgradeState" }, "MachineConfigurationOutOfSync": { "title": "Boolean", "type": "boolean", "description": "Flag indicating whether the machine's configuration is out of sync with the catalog's latest configuration", "nullable": true }, "UpgradeDetail": { "description": "Detail about the VDA upgrade schedule status object associated\nwith this machine.", "nullable": true, "$ref": "#/components/schemas/MachineUpgradeDetail" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of this machine.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "IconId": { "title": "String", "type": "string", "description": "The machine's icon that is displayed in Receiver.", "nullable": true }, "CriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "The machine's critical issues", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfMachineCriticalIssueType" } }, "NonCriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "The machine's noncritical issues", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfMachineNonCriticalIssueType" } }, "CloudPCProvisioningType": { "title": "String", "type": "string", "description": "Specifies provisioning type for Windows365 Cloud PC.\n ", "nullable": true }, "IsDraining": { "title": "Boolean", "type": "boolean", "description": "Flag indicating whether this machine is draining for any reason.", "nullable": true }, "DrainingReason": { "title": "String", "type": "string", "description": "Reason why a worker is in a draining state.", "nullable": true }, "ProvisioningMaintenanceMode": { "title": "String", "type": "string", "description": "Specifies provisioning maintenance mode which may be used by MCS maintenance task or VUS task.\n ", "nullable": true }, "ConnectorName": { "title": "String", "type": "string", "description": "The name of the connector through which the machine is managed.\n ", "nullable": true }, "ConnectorId": { "title": "Guid", "type": "string", "description": "The Id of the connector through which the machine is managed.\n ", "format": "guid", "nullable": true } } } ] }, "MachineResponseModelCollection": { "title": "MachineResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfMachineResponseModel" }, { "type": "object", "description": "Response object for collections of MachineResponseMode.", "additionalProperties": false } ] }, "MachineTestResponseModel": { "title": "MachineTestResponseModel", "type": "object", "additionalProperties": false, "properties": { "Machine": { "description": "The Machine upon which the test was run.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "Status": { "description": "Status.", "$ref": "#/components/schemas/CloudHealthCheckStatus" }, "CommandResponse": { "title": "String", "type": "string", "description": "CommandResponse.", "nullable": true }, "ErrorMessage": { "title": "String", "type": "string", "description": "ErrorMessage.", "nullable": true }, "CommandName": { "title": "String", "type": "string", "description": "CommandName.", "nullable": true }, "CategoryName": { "title": "String", "type": "string", "description": "CategoryName.", "nullable": true }, "CreatedBy": { "title": "String", "type": "string", "description": "The owner of the test", "nullable": true }, "TestReport": { "title": "String", "type": "string", "description": "The detailed test report.", "nullable": true } } }, "MachineType": { "title": "MachineType", "type": "string", "description": "Types of machine.", "x-enumNames": [ "Unknown", "Virtual", "Physical" ], "enum": [ "Unknown", "Virtual", "Physical" ] }, "MachineUnavailableReason": { "title": "MachineUnavailableReason", "type": "string", "description": "Azure AD join type for machines", "x-enumNames": [ "Unknown", "None", "LoadManagementInitializing", "PvdInitializing", "PvdFailed", "GctConnectionInitializing", "AzureAdJoinInitializing", "IntuneEnrollPending", "AzureArcOnboardingRequired" ], "enum": [ "Unknown", "None", "LoadManagementInitializing", "PvdInitializing", "PvdFailed", "GctConnectionInitializing", "AzureAdJoinInitializing", "IntuneEnrollPending", "AzureArcOnboardingRequired" ] }, "MachineUpgradeDetail": { "title": "MachineUpgradeDetail", "type": "object", "description": "Status detail of last VDA upgrade schedule for a machine.", "additionalProperties": false, "properties": { "Uuid": { "title": "String", "type": "string", "description": "Uuid of this upgrade status object.", "nullable": true }, "ScheduleStatus": { "description": "State of this upgrade status object. Exact type TBD.", "nullable": true, "$ref": "#/components/schemas/VdaUpgradeMachineScheduleStatus" }, "StatusMessage": { "title": "String", "type": "string", "description": "Status message resulted from the action of this upgrade status object.", "nullable": true }, "LastStateChangeTimeUtc": { "title": "String", "type": "string", "description": "UTC time when this upgrade status object changed status\nfor the last time.", "nullable": true }, "ScheduledTimeUtc": { "title": "String", "type": "string", "description": "UTC time when this VDA upgrade is scheduled to start.", "nullable": true }, "DurationInHours": { "title": "Int32", "type": "integer", "description": "Timeout duration in hours, of the current VDA upgrade schdeule.", "format": "int32", "nullable": true }, "TargetPackageVersion": { "title": "String", "type": "string", "description": "Target package version of the current VDA upgrade schdeule.", "nullable": true } } }, "MaintenanceCycleTaskDetailResponseModel": { "title": "MaintenanceCycleTaskDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/TaskDetailResponseModel" }, { "type": "object", "description": "Response object for a task of maintenance cycle.", "additionalProperties": false, "properties": { "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "The name of provisioning scheme.", "nullable": true }, "ProvisioningSchemeUid": { "title": "String", "type": "string", "description": "The uid of provisioning scheme.", "nullable": true }, "PurgeDBAfter": { "title": "Int32", "type": "integer", "description": "Purge task data after a certain number of days.", "format": "int32", "nullable": true }, "SessionWarningLogOffTitle": { "title": "String", "type": "string", "description": "The title of session log off warning. ", "nullable": true }, "SessionWarningLogOffMessage": { "title": "String", "type": "string", "description": "The message of session log off warning.", "nullable": true }, "SessionWarningTime": { "title": "Int32", "type": "integer", "description": "The countdown duration for session log off, in minutes.", "format": "int32", "nullable": true }, "AllVms": { "title": "Boolean", "type": "boolean", "description": "If maintenance cycle created base on machine catalog." }, "NewVmsOnly": { "title": "Boolean", "type": "boolean", "description": "If maintenance cycle oly applies to new VMs." }, "MaxDuration": { "title": "Int32", "type": "integer", "description": "The max duration for the task to execute, in minutes.", "format": "int32", "nullable": true } } } ] }, "MaintenanceModeReason": { "title": "MaintenanceModeReason", "type": "string", "description": "The reason why the machine was placed in maintenance mode (if it is in maintenance mode)", "x-enumNames": [ "Unknown", "None", "Administrator", "MaxFailedRegistrations" ], "enum": [ "Unknown", "None", "Administrator", "MaxFailedRegistrations" ] }, "MCSImportData": { "title": "MCSImportData", "type": "object", "additionalProperties": false, "properties": { "IdentityPool": { "title": "String", "type": "string", "nullable": true }, "ProvisioningScheme": { "title": "String", "type": "string", "nullable": true } } }, "MeResponseModel": { "title": "MeResponseModel", "type": "object", "description": "Details about the currently logged-in administrator.", "additionalProperties": false, "required": [ "UserId", "ExpiryTime", "RefreshExpirationTime", "Customers" ], "properties": { "UserId": { "title": "String", "type": "string", "description": "Id of the logged-in user.\nInternally: this is the *sub* from the bearer token. NOT the user_id.", "minLength": 1 }, "DisplayName": { "title": "String", "type": "string", "description": "Display name of the user.\nInternally: the *displayname* from the bearer token.", "nullable": true }, "ExpiryTime": { "title": "String", "type": "string", "description": "Time when the login token expires.\nRFC 3339 compatible format.\nInternally: the *exp* from the bearer token, converted to RFC 3339.", "minLength": 1 }, "RefreshExpirationTime": { "title": "String", "type": "string", "description": "Time after which the login token can no longer be refreshed.\nRFC 3339 compatible format.\nInternally: the *refresh_expiration* from the bearer token, converted to RFC 3339.", "minLength": 1 }, "VerifiedEmail": { "title": "String", "type": "string", "description": "Verified email of the user.", "nullable": true }, "IsCspCustomer": { "title": "Boolean", "type": "boolean", "description": "True if the current customer is a csp customer(partner/tenant)" }, "Customers": { "title": "MyCustomerResponseModel[]", "type": "array", "description": "List of customers and sites accessible by the user.", "items": { "$ref": "#/components/schemas/MyCustomerResponseModel" } } } }, "MessageStyle": { "title": "MessageStyle", "type": "string", "description": "Style of message box to use.", "x-enumNames": [ "Unknown", "Critical", "Question", "Exclamation", "Information" ], "enum": [ "Unknown", "Critical", "Question", "Exclamation", "Information" ] }, "MisConfigurationCategory": { "title": "MisConfigurationCategory", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Warning", "Error", "Info" ], "enum": [ "Unknown", "Warning", "Error", "Info" ] }, "ModelingRequestContract": { "title": "ModelingRequestContract", "type": "object", "description": "Modeling request model.", "additionalProperties": false, "properties": { "DomainController": { "title": "String", "type": "string", "description": "The domain controller.", "nullable": true }, "ComputerIdentity": { "title": "String", "type": "string", "description": "The computer.", "nullable": true }, "UserIdentity": { "title": "String", "type": "string", "description": "The user.", "nullable": true }, "SiteName": { "title": "String", "type": "string", "description": "The site name.", "nullable": true }, "Computer": { "title": "String", "type": "string", "description": "The selected computer.", "nullable": true }, "ComputerContainer": { "title": "String", "type": "string", "description": "Selected computer container.", "nullable": true }, "User": { "title": "String", "type": "string", "description": "Selected user.", "nullable": true }, "UserSid": { "title": "String", "type": "string", "description": "SID of the selected user.", "nullable": true }, "DistinguishedName": { "title": "String", "type": "string", "description": "User distinguished name.", "nullable": true }, "GroupSids": { "title": "String[]", "type": "array", "description": "SIDs of the groups to which the user belongs.", "nullable": true, "items": { "title": "String", "type": "string" } }, "UserContainer": { "title": "String", "type": "string", "description": "Selected user container.", "nullable": true }, "ClientIPAddress": { "title": "String", "type": "string", "description": "Client IP address.", "nullable": true }, "ClientName": { "title": "String", "type": "string", "description": "Client name.", "nullable": true }, "ClientPlatform": { "title": "String", "type": "string", "description": "Client platform.", "nullable": true }, "DeliveryGroup": { "title": "String", "type": "string", "description": "Delivery group.", "nullable": true }, "DeliveryGroupType": { "title": "String", "type": "string", "description": "Delivery group type, values are members of enum DesktopKind.", "nullable": true }, "DeliveryGroupTags": { "title": "String[]", "type": "array", "description": "Delivery group tags.", "nullable": true, "items": { "title": "String", "type": "string" } }, "IsUsingAccessGateway": { "title": "Boolean", "type": "boolean", "description": "Using Access Gateway." }, "AccessGatewayFarm": { "title": "String", "type": "string", "description": "Access Gateway farm.", "nullable": true }, "AccessGatewayTags": { "title": "String[]", "type": "array", "description": "Access Gateway tags.", "nullable": true, "items": { "title": "String", "type": "string" } }, "IsUsingWanScaler": { "title": "Boolean", "type": "boolean", "description": "Using WanScaler (NetScaler SD-WAN)." } } }, "ModelingResponseContract": { "title": "ModelingResponseContract", "type": "object", "description": "Data contract for group policy modeling response.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "A name for the response. This is just hard coded.", "nullable": true }, "User": { "title": "String", "type": "string", "description": "The username.", "nullable": true }, "Machine": { "title": "String", "type": "string", "description": "The machine name.", "nullable": true }, "Result": { "description": "Simulation result.", "nullable": true, "$ref": "#/components/schemas/ModelingResultContract" } } }, "ModelingResultContract": { "title": "ModelingResultContract", "type": "object", "description": "Result of a modeling or simulation.", "additionalProperties": false, "properties": { "IsMachineRsop": { "title": "Boolean", "type": "boolean", "description": "The report is for machine or user." }, "LastProcessTime": { "title": "DateTime", "type": "string", "description": "The most recent simulation time.", "format": "date-time" }, "AppliedSettings": { "title": "AppliedSetting[]", "type": "array", "description": "Applied settings.", "nullable": true, "items": { "$ref": "#/components/schemas/AppliedSetting2" } }, "AppliedPolicies": { "title": "AppliedPolicy[]", "type": "array", "description": "Applied policies.", "nullable": true, "items": { "$ref": "#/components/schemas/AppliedPolicy2" } }, "FilterEvidence": { "title": "Dictionary`2", "type": "object", "description": "Filter evidence used for the simulation.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "LosingSettings": { "title": "LosingSetting[]", "type": "array", "description": "Settings that did not get applied.", "nullable": true, "items": { "$ref": "#/components/schemas/LosingSetting2" } }, "LosingPolicies": { "title": "LosingPolicy[]", "type": "array", "description": "Policies that did not get applied. Some of them should be applied in theory but not applied in practice.", "nullable": true, "items": { "$ref": "#/components/schemas/LosingPolicy2" } } } }, "MultiSiteModel": { "title": "MultiSiteModel", "type": "object", "description": "Site information for Multi sites", "additionalProperties": false, "required": [ "DisplayName" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Site Name", "maxLength": 64, "nullable": true }, "DisplayName": { "title": "String", "type": "string", "description": "The site's friendly name", "maxLength": 64, "minLength": 1 }, "DeliveryControllers": { "title": "String[]", "type": "array", "description": "The Orchestration servers belongs to the site, only applicable for On-Prem.", "nullable": true, "items": { "title": "String", "type": "string" } }, "WebServerAddress": { "title": "String", "type": "string", "description": "The On-Prem web studio server address, this setting is only applicable for Cloud deployment.", "nullable": true }, "Default": { "title": "Boolean", "type": "boolean", "description": "Indicate if it is the default site.", "default": false } } }, "MultiTenantServicesAccessModel": { "title": "MultiTenantServicesAccessModel", "type": "object", "description": "Multi-tenant services access to DaaS.", "additionalProperties": false, "properties": { "XaCatalogService": { "title": "Boolean", "type": "boolean", "description": "Indicate whether Citrix DaaS Standard for Azure is allowed.", "nullable": true }, "XdQuickCreateService": { "title": "Boolean", "type": "boolean", "description": "Indicate whether Citrix DaaS for Amazon WorkSpaces Core is allowed.", "nullable": true }, "XdCloudPcRegistrationService": { "title": "Boolean", "type": "boolean", "description": "Indicate whether Citrix HDX Plus for Windows 365 is allowed.", "nullable": true }, "Itsm": { "title": "Boolean", "type": "boolean", "description": "Indicate whether Citrix ITSM Adapter service is allowed.", "nullable": true } } }, "MyCustomerResponseModel": { "title": "MyCustomerResponseModel", "type": "object", "description": "Response object indicating a customer who the currently-logged-in\nadmin has access to.", "additionalProperties": false, "required": [ "Id", "Sites" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the customer.\ninternally: the CC customer id / short-name, or for on-prem\nthis could be any generated guid.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Human-readable name of the customer. Not necessarily unique.\ninternally: the CC customer full name, or for on-prem this\ncan be something hardcoded.", "nullable": true }, "Sites": { "title": "MySiteResponseModel[]", "type": "array", "description": "Sites which the admin has access to within the customer.", "items": { "$ref": "#/components/schemas/MySiteResponseModel" } } } }, "MySiteResponseModel": { "title": "MySiteResponseModel", "type": "object", "description": "Response object indicating a site within a customer which the currently\nlogged-in administrator has access to.", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the site.\nIn the cloud this is the \"Virtual site ID\". On-prem this should be\nthe XD farm guid.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the site.", "minLength": 1 } } }, "NameValueIntPairModel": { "title": "NameValueIntPairModel", "type": "object", "description": "A name/value pair, with the value of (JSON) type Number.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name.", "nullable": true }, "Value": { "title": "Int32", "type": "integer", "description": "Value.", "format": "int32" } } }, "NameValueStringPairModel": { "title": "NameValueStringPairModel", "type": "object", "description": "A name/value pair, with the value of (JSON) type String.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name.", "nullable": true, "example": "Name" }, "Value": { "title": "String", "type": "string", "description": "Value.", "nullable": true, "example": "Value" } } }, "NameValueStringPairModelCollection": { "title": "NameValueStringPairModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfNameValueStringPairModel" }, { "type": "object", "description": "Collection type of NameValueStringPairModel", "additionalProperties": false } ] }, "NamingSchemeType": { "title": "NamingSchemeType", "type": "string", "description": "Naming scheme type for creating machine account names during provisioning.", "x-enumNames": [ "Unknown", "None", "Numeric", "Alphabetic", "Unicode" ], "enum": [ "Unknown", "None", "Numeric", "Alphabetic", "Unicode" ] }, "NetworkMapRequestModel": { "title": "NetworkMapRequestModel", "type": "object", "description": "Network map request object.", "additionalProperties": false, "required": [ "NetworkPath" ], "properties": { "DeviceNameOrId": { "title": "String", "type": "string", "description": "`DEPRECATED. Use .` The name or Id of the network. Required.", "maxLength": 2147483647, "pattern": ".*", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use .", "nullable": true, "example": "Name or Id of the network" }, "NetworkDeviceNameOrId": { "title": "String", "type": "string", "description": "The name or Id of the network device.", "maxLength": 2147483647, "pattern": ".*", "nullable": true, "example": "Name or Id of the network device" }, "NetworkPath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual network that the device\nshould be attached to.\nThis must be a path to a Network item in the\nresource pool to which the Machine Catalog is associated.", "maxLength": 2147483647, "minLength": 1, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "example": "For example, XDHyp:\\path\\to\\network" } } }, "NetworkMapResponseModel": { "title": "NetworkMapResponseModel", "type": "object", "description": "Network map response object.", "additionalProperties": false, "required": [ "DeviceId", "Network" ], "properties": { "DeviceName": { "title": "String", "type": "string", "description": "The name for the network. This is for display only and may not be populated.", "nullable": true }, "DeviceId": { "title": "String", "type": "string", "description": "Network device ID. Zero indicates the primary network device.", "minLength": 1 }, "Network": { "description": "Network which the device is attached to. ", "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "IsCardEnabled": { "title": "Boolean", "type": "boolean", "description": "Gets or sets a value indicating whether IsCardEnabled." } } }, "NewHighLevelOperationRequestModel": { "title": "NewHighLevelOperationRequestModel", "type": "object", "description": "Model for a high level log operation.", "additionalProperties": false, "required": [ "OperationType", "Source", "Text", "IsSuccessful" ], "properties": { "OperationType": { "description": "Type of operation.", "$ref": "#/components/schemas/LogOperationType" }, "Source": { "title": "String", "type": "string", "description": "Source of the operation.", "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9\\s]+$" }, "Text": { "title": "String", "type": "string", "description": "Human-readable description of the change.", "minLength": 1 }, "IsSuccessful": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the operation completed successfully." } } }, "NotifiableJobType": { "title": "NotifiableJobType", "type": "string", "description": "Job types that can be notified in notification center.", "x-enumNames": [ "Unknown", "CreateDeliveryGroup", "UpdateDeliveryGroup", "DeleteDeliveryGroup", "AddDeliveryGroupMachines", "RemoveDeliveryGroupMachines", "AddDeliveryGroupApplications", "RemoveDeliveryGroupApplications", "RemoveDeliveryGroupApplicationGroups", "RefreshAppVApplications", "TestDeliveryGroup", "CreateTag", "UpdateTag", "DeleteTag", "AddIcon", "RemoveIcon", "SetTagApplications", "SetTagApplicationGroups", "SetTagDeliveryGroups", "SetTagDesktops", "SetTagMachineCatalogs", "SetTagMachines", "RebootMachines", "ShutDownMachines", "StartMachines", "SuspendMachines", "ResumeMachines", "CreateAdminFolder", "CreateApplicationFolder", "CreateRebootSchedule", "UpdateRebootSchedule", "DeleteRebootSchedule", "CreatePowerTimeScheme", "UpdatePowerTimeScheme", "DeletePowerTimeScheme", "CreateAdvancedAccessPolicy", "UpdateAdvancedAccessPolicy", "DeleteAdvancedAccessPolicy", "CreateResourceAccessPolicy", "UpdateResourceAccessPolicy", "DeleteResourceAccessPolicy", "AddMachineCatalogMachine", "UpdateMachineCatalogProvisioningScheme", "CreateMachineCatalog", "CreateMachineIdentity", "DeleteMachineIdentity", "UpdateMachineIdentity", "UpdateUserIdentity", "UpdateMachineCatalog", "DeleteMachineCatalog", "TestMachineCatalog", "LogoffSessions", "DisconnectSessions", "LogoffMachineSessions", "DeleteMachine", "SendSessionMessage", "AddApplications", "CreateApplicationGroup", "DeleteApplication", "DeleteApplicationGroup", "DeleteAdminFolder", "DeleteApplicationFolder", "RemoveApplicationGroupApplications", "UpdateApplication", "UpdateApplicationGroup", "UpdateAdminFolder", "UpdateApplicationFolder", "ApplicationsDiscovery", "ModifyFTA", "ImportFTA", "TestSite", "CreateHypervisor", "CreateHypervisorResourcePool", "UpdateHypervisor", "UpdateHypervisorResourcePool", "HypervisorVmValidation", "TestHypervisor", "TestHypervisorResourcePool", "CreateStoreFrontServer", "DeleteStoreFrontServer", "UpdateStoreFrontServer", "UpdateImage", "SetProvScheme", "AddMachines", "UpdateMachineCatalogMachine", "RollbackMachineCatalogProvisioningScheme", "DeleteHypervisor", "DeleteResourcePool", "ExportOperationReport", "DeleteAllOperations", "UpdateOperation", "NewOperation", "ImportAppVPackages", "AddAppVServer", "UpdateAppVServer", "RemoveAppVServer", "RemoveAppVPackage", "DeleteAppVIsolationGroup", "CreateAppVIsolationGroup", "UpdateAppVIsolationGroup", "CreateZone", "EditZone", "DeleteZone", "AddItemsIntoZone", "MoveItemsIntoZone", "RemoveItemsFromZone", "StartDeliveryGroupRebootCycle", "CreateAdminScope", "DeleteAdminScope", "CreateAdminRole", "UpdateAdminRole", "DeleteAdminRole", "UpdateAdminScope", "SetBrokerHypervisorConnection", "ResetBrokerHypervisorConnection", "CancelCatalogAction", "DeleteAllCatalogActions", "DeleteCatalogActions", "HideSession", "UnhideSession", "CreateMachineCatalogUpgradeSchedule", "RemoveMachineCatalogUpgradeSchedule", "UpdateMachineCatalogUpgradeSchedule", "RemoveMaintenanceCycle", "CancelMaintenanceCycle", "RestartMaintenanceCycle", "CreateMaintenanceCycle", "UpdateMaintenanceCycle", "ResetProvisionedVirtualMachineOSDisk", "CreateMachineUpgradeSchedule", "UpdateMachineUpgradeSchedule", "RemoveMachineUpgradeSchedule", "CreateMachinesUpgradeScheudle", "CreateAppLibPackageDiscoveryProfile", "UpdateAppLibPackageDiscoveryProfile", "RemoveAppLibPackageDiscoveryProfile", "ValidateHypervisorResourcePoolResource", "CreateAppLibPackageDiscovery", "SendCasEvent", "AddDeliveryGroupPolicySet", "RemoveDeliveryGroupPolicySet", "StartSessionRecording", "StopSessionRecording", "RemoveMachinePowerActionSchedule", "SetLicenseServer", "AddLicense", "DeleteDeliveryController", "ChangeDatabase", "AllocateLicense", "ValidateMachineCatalogVDAComponentsAndFeaturesSelection", "RemoveImageDefinition", "CreateImageVersion", "SetImageVersion", "DeleteImageVersion", "RequestProvVmUpdate", "CreateAdmin", "UpdateAdmin", "DeleteAdmin", "PinBackup", "ResetVMDisk", "RepairMachineCatalogAccounts", "ImportProvisionedVirtualMachines", "ValidateMachineCatalogCreation", "RemoveProvisioningOperationEvent", "ConfirmProvisioningOperationEvent", "TestServiceAccount", "UpdateImageVersionResourcePools", "CreateImageDefinition", "ValidateVDAComponentsAndFeaturesSelection", "UpdateProvisionedVirtualMachine", "ApplyProvisionedVirtualMachineConfigurationUpdate", "NewAutoscalePluginTemplate", "UpdateAutoscalePluginTemplate", "DeleteAutoscalePluginTemplate", "NewDeliveryGroupAutoscaleGroupPlugin", "UpdateDeliveryGroupAutoscaleGroupPlugin", "DeleteDeliveryGroupAutoscaleGroupPluginByUid", "GenerateAdvisorRecommendation", "CreateServiceAccount", "SetServiceAccount", "TestMachine", "CreateProvisioningSchemeConfiguration", "RemoveProvisioningSchemeConfiguration", "CreateProvisionedVirtualMachineConfiguration", "RemoveProvisionedVirtualMachineConfiguration", "ScheduleProvisioningSchemeHardwareUpdate", "ScheduleProvisionedVirtualMachineHardwareUpdate", "CreateProvisionedVMConfigurationAndScheduleUpdate", "UpdateMachineCatalogPvsSchemeVDisk", "UpdateMachineCatalogPvsSchemeBdm", "DeleteProvisionedBackup", "ScheduleTakeProvisionedBackup", "ScheduleRestoreToProvisionedBackup", "SelectAllAction", "ConfirmProvisioningSchemeOperationEvents", "ConfirmProvisionedVirtualMachineOperationEvents", "ScheduleProvisioningSchemeImageUpdate", "ScheduleResetProvisionedVirtualMachineOSDisk" ], "enum": [ "Unknown", "CreateDeliveryGroup", "UpdateDeliveryGroup", "DeleteDeliveryGroup", "AddDeliveryGroupMachines", "RemoveDeliveryGroupMachines", "AddDeliveryGroupApplications", "RemoveDeliveryGroupApplications", "RemoveDeliveryGroupApplicationGroups", "RefreshAppVApplications", "TestDeliveryGroup", "CreateTag", "UpdateTag", "DeleteTag", "AddIcon", "RemoveIcon", "SetTagApplications", "SetTagApplicationGroups", "SetTagDeliveryGroups", "SetTagDesktops", "SetTagMachineCatalogs", "SetTagMachines", "RebootMachines", "ShutDownMachines", "StartMachines", "SuspendMachines", "ResumeMachines", "CreateAdminFolder", "CreateApplicationFolder", "CreateRebootSchedule", "UpdateRebootSchedule", "DeleteRebootSchedule", "CreatePowerTimeScheme", "UpdatePowerTimeScheme", "DeletePowerTimeScheme", "CreateAdvancedAccessPolicy", "UpdateAdvancedAccessPolicy", "DeleteAdvancedAccessPolicy", "CreateResourceAccessPolicy", "UpdateResourceAccessPolicy", "DeleteResourceAccessPolicy", "AddMachineCatalogMachine", "UpdateMachineCatalogProvisioningScheme", "CreateMachineCatalog", "CreateMachineIdentity", "DeleteMachineIdentity", "UpdateMachineIdentity", "UpdateUserIdentity", "UpdateMachineCatalog", "DeleteMachineCatalog", "TestMachineCatalog", "LogoffSessions", "DisconnectSessions", "LogoffMachineSessions", "DeleteMachine", "SendSessionMessage", "AddApplications", "CreateApplicationGroup", "DeleteApplication", "DeleteApplicationGroup", "DeleteAdminFolder", "DeleteApplicationFolder", "RemoveApplicationGroupApplications", "UpdateApplication", "UpdateApplicationGroup", "UpdateAdminFolder", "UpdateApplicationFolder", "ApplicationsDiscovery", "ModifyFTA", "ImportFTA", "TestSite", "CreateHypervisor", "CreateHypervisorResourcePool", "UpdateHypervisor", "UpdateHypervisorResourcePool", "HypervisorVmValidation", "TestHypervisor", "TestHypervisorResourcePool", "CreateStoreFrontServer", "DeleteStoreFrontServer", "UpdateStoreFrontServer", "UpdateImage", "SetProvScheme", "AddMachines", "UpdateMachineCatalogMachine", "RollbackMachineCatalogProvisioningScheme", "DeleteHypervisor", "DeleteResourcePool", "ExportOperationReport", "DeleteAllOperations", "UpdateOperation", "NewOperation", "ImportAppVPackages", "AddAppVServer", "UpdateAppVServer", "RemoveAppVServer", "RemoveAppVPackage", "DeleteAppVIsolationGroup", "CreateAppVIsolationGroup", "UpdateAppVIsolationGroup", "CreateZone", "EditZone", "DeleteZone", "AddItemsIntoZone", "MoveItemsIntoZone", "RemoveItemsFromZone", "StartDeliveryGroupRebootCycle", "CreateAdminScope", "DeleteAdminScope", "CreateAdminRole", "UpdateAdminRole", "DeleteAdminRole", "UpdateAdminScope", "SetBrokerHypervisorConnection", "ResetBrokerHypervisorConnection", "CancelCatalogAction", "DeleteAllCatalogActions", "DeleteCatalogActions", "HideSession", "UnhideSession", "CreateMachineCatalogUpgradeSchedule", "RemoveMachineCatalogUpgradeSchedule", "UpdateMachineCatalogUpgradeSchedule", "RemoveMaintenanceCycle", "CancelMaintenanceCycle", "RestartMaintenanceCycle", "CreateMaintenanceCycle", "UpdateMaintenanceCycle", "ResetProvisionedVirtualMachineOSDisk", "CreateMachineUpgradeSchedule", "UpdateMachineUpgradeSchedule", "RemoveMachineUpgradeSchedule", "CreateMachinesUpgradeScheudle", "CreateAppLibPackageDiscoveryProfile", "UpdateAppLibPackageDiscoveryProfile", "RemoveAppLibPackageDiscoveryProfile", "ValidateHypervisorResourcePoolResource", "CreateAppLibPackageDiscovery", "SendCasEvent", "AddDeliveryGroupPolicySet", "RemoveDeliveryGroupPolicySet", "StartSessionRecording", "StopSessionRecording", "RemoveMachinePowerActionSchedule", "SetLicenseServer", "AddLicense", "DeleteDeliveryController", "ChangeDatabase", "AllocateLicense", "ValidateMachineCatalogVDAComponentsAndFeaturesSelection", "RemoveImageDefinition", "CreateImageVersion", "SetImageVersion", "DeleteImageVersion", "RequestProvVmUpdate", "CreateAdmin", "UpdateAdmin", "DeleteAdmin", "PinBackup", "ResetVMDisk", "RepairMachineCatalogAccounts", "ImportProvisionedVirtualMachines", "ValidateMachineCatalogCreation", "RemoveProvisioningOperationEvent", "ConfirmProvisioningOperationEvent", "TestServiceAccount", "UpdateImageVersionResourcePools", "CreateImageDefinition", "ValidateVDAComponentsAndFeaturesSelection", "UpdateProvisionedVirtualMachine", "ApplyProvisionedVirtualMachineConfigurationUpdate", "NewAutoscalePluginTemplate", "UpdateAutoscalePluginTemplate", "DeleteAutoscalePluginTemplate", "NewDeliveryGroupAutoscaleGroupPlugin", "UpdateDeliveryGroupAutoscaleGroupPlugin", "DeleteDeliveryGroupAutoscaleGroupPluginByUid", "GenerateAdvisorRecommendation", "CreateServiceAccount", "SetServiceAccount", "TestMachine", "CreateProvisioningSchemeConfiguration", "RemoveProvisioningSchemeConfiguration", "CreateProvisionedVirtualMachineConfiguration", "RemoveProvisionedVirtualMachineConfiguration", "ScheduleProvisioningSchemeHardwareUpdate", "ScheduleProvisionedVirtualMachineHardwareUpdate", "CreateProvisionedVMConfigurationAndScheduleUpdate", "UpdateMachineCatalogPvsSchemeVDisk", "UpdateMachineCatalogPvsSchemeBdm", "DeleteProvisionedBackup", "ScheduleTakeProvisionedBackup", "ScheduleRestoreToProvisionedBackup", "SelectAllAction", "ConfirmProvisioningSchemeOperationEvents", "ConfirmProvisionedVirtualMachineOperationEvents", "ScheduleProvisioningSchemeImageUpdate", "ScheduleResetProvisionedVirtualMachineOSDisk" ] }, "ObjectType": { "title": "ObjectType", "type": "string", "description": "Types of object.", "x-enumNames": [ "Unknown", "MachineCatalog", "DeliveryGroup", "Machine", "Application", "ApplicationGroup", "AdminFolder", "Tag", "AdminRole", "AdminScope", "Hypervisor", "RemotePCEnrollmentScope", "RebootSchedule", "ResourcePool", "Image", "Zone", "Site", "Licensing", "ServiceAccount" ], "enum": [ "Unknown", "MachineCatalog", "DeliveryGroup", "Machine", "Application", "ApplicationGroup", "AdminFolder", "Tag", "AdminRole", "AdminScope", "Hypervisor", "RemotePCEnrollmentScope", "RebootSchedule", "ResourcePool", "Image", "Zone", "Site", "Licensing", "ServiceAccount" ] }, "OciEnvironment": { "title": "OciEnvironment", "type": "string", "description": "OCI environments", "x-enumNames": [ "Commercial", "USGovernment", "UKGovernment" ], "enum": [ "Commercial", "USGovernment", "UKGovernment" ] }, "OperatingSystemInfoResponseModel": { "title": "OperatingSystemInfoResponseModel", "type": "object", "description": "The operating sysytem information", "additionalProperties": false, "properties": { "Type": { "title": "String", "type": "string", "nullable": true }, "FullName": { "title": "String", "type": "string", "nullable": true } } }, "OsType": { "title": "OsType", "type": "string", "description": "Operating System types.", "x-enumNames": [ "Unknown", "Windows", "Linux" ], "enum": [ "Unknown", "Windows", "Linux" ] }, "PackagedApplicationType": { "title": "PackagedApplicationType", "type": "string", "description": "Packaged Application types.", "x-enumNames": [ "NotApplicable", "AppVSingleAdmin", "AppVDualAdmin", "Msix", "AppAttach", "FlexApp", "ElasticAppLayer", "Cloudpager", "Cloudpaging" ], "enum": [ "NotApplicable", "AppVSingleAdmin", "AppVDualAdmin", "Msix", "AppAttach", "FlexApp", "ElasticAppLayer", "Cloudpager", "Cloudpaging" ] }, "PackagedApplicationVisibility": { "title": "PackagedApplicationVisibility", "type": "string", "description": "Packaged Application visibility.", "x-enumNames": [ "None", "Workspace", "Desktop", "WorkspaceAndDesktop" ], "enum": [ "None", "Workspace", "Desktop", "WorkspaceAndDesktop" ] }, "PagingFileSettingResponseModel": { "title": "PagingFileSettingResponseModel", "type": "object", "description": "Paging file location like: ?:\\pagefile.sys, C:\\pagefile.sys", "additionalProperties": false, "properties": { "Path": { "title": "String", "type": "string", "description": "Paging file location like: ?:\\pagefile.sys, C:\\pagefile.sys", "nullable": true }, "InitialSizeInMb": { "title": "Int32", "type": "integer", "description": "Paging file minimum size in MB.", "format": "int32" }, "MaxSizeInMb": { "title": "Int32", "type": "integer", "description": "Paging file maximum size in MB.", "format": "int32" }, "IsSystemManaged": { "title": "Boolean", "type": "boolean", "description": "If system managed, return true,\nOtherWise return false." } } }, "PersistChanges": { "title": "PersistChanges", "type": "string", "description": "Methods by which changes are persisted on a machine.", "x-enumNames": [ "Unknown", "Discard", "OnLocal" ], "enum": [ "Unknown", "Discard", "OnLocal" ] }, "PolicyBodyRequest": { "title": "PolicyBodyRequest", "type": "object", "description": "Data for policy request.", "additionalProperties": false, "properties": { "name": { "title": "String", "type": "string", "description": "Policy name.", "nullable": true }, "isEnabled": { "title": "Boolean", "type": "boolean", "description": "Is policy enabled." }, "description": { "title": "String", "type": "string", "description": "Policy description.", "nullable": true } } }, "PolicyProperty": { "title": "PolicyProperty", "type": "string", "description": "Names of policy properties that can be specified in a search.", "x-enumNames": [ "Description", "IsEnabled", "Name", "Priority" ], "enum": [ "Description", "IsEnabled", "Name", "Priority" ] }, "PolicyRequest": { "title": "PolicyRequest", "type": "object", "description": "Data for policy request.", "additionalProperties": false, "properties": { "name": { "title": "String", "type": "string", "description": "Policy name.", "nullable": true }, "isEnabled": { "title": "Boolean", "type": "boolean", "description": "Is policy enabled." }, "description": { "title": "String", "type": "string", "description": "Policy description.", "nullable": true }, "settings": { "title": "SettingRequest[]", "type": "array", "description": "Policy settings.", "nullable": true, "items": { "$ref": "#/components/schemas/SettingRequest" } }, "filters": { "title": "FilterRequest[]", "type": "array", "description": "Policy filters.", "nullable": true, "items": { "$ref": "#/components/schemas/FilterRequest" } } } }, "PolicyRequestContract": { "title": "PolicyRequestContract", "type": "object", "description": "Policy request model", "additionalProperties": false, "properties": { "PolicyName": { "title": "String", "type": "string", "description": "Policy name as identifier, translated.", "nullable": true }, "IsEnabled": { "title": "Boolean", "type": "boolean", "description": "Is policy enabled", "default": false, "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Policy description", "nullable": true }, "Priority": { "title": "Int32", "type": "integer", "description": "New policy priority", "format": "int32", "nullable": true }, "Settings": { "title": "IEnumerable`1", "type": "array", "description": "Policy settings", "nullable": true, "items": { "$ref": "#/components/schemas/SettingRequestContract" } }, "Filters": { "title": "IEnumerable`1", "type": "array", "description": "Policy filters", "nullable": true, "items": { "$ref": "#/components/schemas/FilterRequestContract" } } } }, "PolicyResponse": { "title": "PolicyResponse", "type": "object", "description": "Policy response.", "additionalProperties": false, "properties": { "policySetGuid": { "title": "Guid", "type": "string", "description": "The policy set that this policy belongs to.", "format": "guid" }, "policyGuid": { "title": "Guid", "type": "string", "description": "Policy GUID.", "format": "guid" }, "policyName": { "title": "String", "type": "string", "description": "Policy name.", "nullable": true }, "priority": { "title": "Int32", "type": "integer", "description": "Policy priority.", "format": "int32" }, "isEnabled": { "title": "Boolean", "type": "boolean", "description": "Is policy enabled." }, "description": { "title": "String", "type": "string", "description": "Policy description.", "nullable": true }, "settings": { "title": "SettingResponse[]", "type": "array", "description": "Policy settings.", "nullable": true, "items": { "$ref": "#/components/schemas/SettingResponse" } }, "filters": { "title": "FilterResponse[]", "type": "array", "description": "Policy filters.", "nullable": true, "items": { "$ref": "#/components/schemas/FilterResponse" } } } }, "PolicyResponseContract": { "title": "PolicyResponseContract", "type": "object", "description": "Policy model", "additionalProperties": false, "properties": { "PolicyName": { "title": "String", "type": "string", "description": "Policy name as identifier, translated.", "nullable": true }, "Priority": { "title": "Int32", "type": "integer", "description": "Policy priority", "format": "int32" }, "IsEnabled": { "title": "Boolean", "type": "boolean", "description": "Is policy enabled" }, "Description": { "title": "String", "type": "string", "description": "Policy description", "nullable": true }, "IsUnfiltered": { "title": "Boolean", "type": "boolean", "description": "Is unfiltered is true only for the 'Unfiltered' policy." }, "Settings": { "title": "IEnumerable`1", "type": "array", "description": "Policy settings", "nullable": true, "items": { "$ref": "#/components/schemas/SettingResponseContract" } }, "Filters": { "title": "IEnumerable`1", "type": "array", "description": "Policy filters", "nullable": true, "items": { "$ref": "#/components/schemas/FilterResponseContract" } } } }, "PolicySearch": { "title": "PolicySearch", "type": "object", "description": "Policy search data.", "additionalProperties": false, "properties": { "SearchFilters": { "title": "SearchFilter[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/SearchFilter2" } }, "SortCriteria": { "description": "Sort criteria for the results. If no sort criteria is specified, the results are unsorted.", "nullable": true, "$ref": "#/components/schemas/SortingMethod2" } } }, "PolicySetRequest": { "title": "PolicySetRequest", "type": "object", "description": "Policy set request.", "additionalProperties": false, "properties": { "policySetType": { "title": "String", "type": "string", "description": "The policy set type.", "nullable": true }, "name": { "title": "String", "type": "string", "description": "Name of the policy set.", "nullable": true }, "description": { "title": "String", "type": "string", "description": "Policy set description.", "nullable": true }, "scopes": { "title": "String[]", "type": "array", "description": "Delegated administration scopes for the policy set.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "PolicySetResponse": { "title": "PolicySetResponse", "type": "object", "description": "GPO policy set data.", "additionalProperties": false, "properties": { "policySetGuid": { "title": "Guid", "type": "string", "description": "Guid of the policy set.", "format": "guid" }, "policySetType": { "description": "The policy set type.", "$ref": "#/components/schemas/SdkGpoPolicySetType" }, "name": { "title": "String", "type": "string", "description": "Name of the policy set.", "nullable": true }, "description": { "title": "String", "type": "string", "description": "Policy set description.", "nullable": true }, "policyCount": { "title": "Int32", "type": "integer", "description": "Number of policies in the policy set.", "format": "int32" }, "policies": { "title": "PolicyResponse[]", "type": "array", "description": "Policies in the policy set.", "nullable": true, "items": { "$ref": "#/components/schemas/PolicyResponse" } }, "scopes": { "title": "String[]", "type": "array", "description": "Delegated admin scopes.", "nullable": true, "items": { "title": "String", "type": "string" } }, "isAssigned": { "title": "Boolean", "type": "boolean", "description": "Indicate if policy set is assigned to at least one delivery group." }, "lastError": { "title": "String", "type": "string", "description": "The most recent error that occurred when the policy data was converted to/from policy set.", "nullable": true } } }, "PolicySetSearch": { "title": "PolicySetSearch", "type": "object", "description": "Policy set search data.", "additionalProperties": false, "properties": { "SearchFilters": { "title": "SearchFilter[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/SearchFilter" } }, "SortCriteria": { "description": "Sort criteria for the results. If no sort criteria is specified, the results are unsorted.", "nullable": true, "$ref": "#/components/schemas/SortingMethod" } } }, "PolicyTemplateResponseContract": { "title": "PolicyTemplateResponseContract", "type": "object", "description": "ALL: Policy and Template", "additionalProperties": false, "properties": { "Policies": { "title": "IEnumerable`1", "type": "array", "description": "Policies", "nullable": true, "items": { "$ref": "#/components/schemas/PolicyResponseContract" } }, "Templates": { "title": "IEnumerable`1", "type": "array", "description": "Templates", "nullable": true, "items": { "$ref": "#/components/schemas/TemplateResponseContract" } } } }, "PoolSizeScheduleRequestModel": { "title": "PoolSizeScheduleRequestModel", "type": "object", "description": "The pool size to power on during a time range.", "additionalProperties": false, "properties": { "TimeRange": { "title": "String", "type": "string", "description": "Time range during which the pool size applies.", "nullable": true, "example": "For example, 00:00-08:00" }, "PoolSize": { "title": "Int32", "type": "integer", "description": "The number of machines (either as an absolute number or a percentage\nof the machines in the delivery group, depending on the value of\nPoolUsingPercentage) that\nare to be maintained in a running state, whether they are in use or\nnot.", "format": "int32" } } }, "PoolSizeScheduleResponseModel": { "title": "PoolSizeScheduleResponseModel", "type": "object", "description": "The pool size to power on during a time range.", "additionalProperties": false, "properties": { "TimeRange": { "title": "String", "type": "string", "description": "Time range during which the pool size applies.", "nullable": true }, "PoolSize": { "title": "Int32", "type": "integer", "description": "The number of machines (either as an absolute number or a percentage\nof the machines in the delivery group, depending on the value of\nPoolUsingPercentage) that\nare to be maintained in a running state, whether they are in use or\nnot.", "format": "int32" } } }, "PowerActionScheduleResponseModel": { "title": "PowerActionScheduleResponseModel", "type": "object", "description": "Power action schedule.", "additionalProperties": false, "properties": { "Action": { "$ref": "#/components/schemas/SupportedPowerAction" }, "ActionDueTime": { "title": "DateTime", "type": "string", "format": "date-time" }, "DNSName": { "title": "String", "type": "string", "nullable": true }, "HostedMachineName": { "title": "String", "type": "string", "nullable": true }, "HypervisorConnectionUid": { "title": "Int32", "type": "integer", "format": "int32" }, "MachineName": { "title": "String", "type": "string", "nullable": true }, "Uid": { "title": "Int64", "type": "integer", "format": "int64" } } }, "PowerActionScheduleResponseModelCollection": { "title": "PowerActionScheduleResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPowerActionScheduleResponseModel" }, { "type": "object", "description": "Reboot schedule response model collection.", "additionalProperties": false } ] }, "PowerShellCommandErrorModel": { "title": "PowerShellCommandErrorModel", "type": "object", "description": "The error reported by command", "additionalProperties": false, "properties": { "FullyQualifiedErrorId": { "title": "String", "type": "string", "description": "The error Id", "nullable": true }, "CategoryMessage": { "title": "String", "type": "string", "description": "The catalog message", "nullable": true }, "InvocationName": { "title": "String", "type": "string", "description": "The invocation name", "nullable": true }, "ErrorMessage": { "title": "String", "type": "string", "description": "The error message", "nullable": true }, "PositionMessage": { "title": "String", "type": "string", "description": "The position message", "nullable": true } } }, "PowerShellExecutedCommandModel": { "title": "PowerShellExecutedCommandModel", "type": "object", "description": "The executed command", "additionalProperties": false, "properties": { "Command": { "title": "String", "type": "string", "description": "The command", "nullable": true }, "Errors": { "title": "PowerShellCommandErrorModel[]", "type": "array", "description": "The errors when the command reported", "nullable": true, "items": { "$ref": "#/components/schemas/PowerShellCommandErrorModel" } } } }, "PowerShellExecutionStatus": { "title": "PowerShellExecutionStatus", "type": "string", "description": "The status of PowerShell execution", "x-enumNames": [ "Unknown", "Failed", "Canceled", "Completed" ], "enum": [ "Unknown", "Failed", "Canceled", "Completed" ] }, "PowerShellHistoryResponseModel": { "title": "PowerShellHistoryResponseModel", "type": "object", "description": "The response model of PowerShell script history", "additionalProperties": false, "properties": { "Title": { "title": "String", "type": "string", "description": "The title of the PowerShell script history", "nullable": true }, "ExecutionTime": { "title": "String", "type": "string", "description": "The execution time of the PowerShell", "nullable": true }, "Status": { "description": "The status of PowerShell execution", "$ref": "#/components/schemas/PowerShellExecutionStatus" }, "TotalCommands": { "title": "Int32", "type": "integer", "description": "The total commands in the execution", "format": "int32" }, "Commands": { "title": "PowerShellExecutedCommandModel[]", "type": "array", "description": "The executed PowerShell commands", "nullable": true, "items": { "$ref": "#/components/schemas/PowerShellExecutedCommandModel" } } } }, "PowerShellHistoryResponseModelCollection": { "title": "PowerShellHistoryResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPowerShellHistoryResponseModel" }, { "type": "object", "description": "The collection of PowerShell history response model", "additionalProperties": false } ] }, "PowerState": { "title": "PowerState", "type": "string", "description": "Power state of a machine.", "x-enumNames": [ "Unknown", "Unmanaged", "Unavailable", "Off", "On", "Suspended", "TurningOn", "TurningOff", "Suspending", "Resuming", "NotSupported", "VirtualMachineNotFound" ], "enum": [ "Unknown", "Unmanaged", "Unavailable", "Off", "On", "Suspended", "TurningOn", "TurningOff", "Suspending", "Resuming", "NotSupported", "VirtualMachineNotFound" ] }, "PowerTimeSchemeRequestModel": { "title": "PowerTimeSchemeRequestModel", "type": "object", "description": "Request object for specifying a power time scheme.", "additionalProperties": false, "properties": { "DaysOfWeek": { "title": "TimeSchemeDays[]", "type": "array", "description": "The pattern of days of the week that the power time scheme covers.", "nullable": true, "items": { "$ref": "#/components/schemas/TimeSchemeDays" } }, "Name": { "title": "String", "type": "string", "description": "The administrative name of the power time scheme.", "maxLength": 64, "pattern": "(.*)*", "nullable": true, "example": "Administrative name of the power time scheme" }, "DisplayName": { "title": "String", "type": "string", "description": "The name of the power time scheme as displayed in the Studio console.", "maxLength": 64, "pattern": "(.*)*", "nullable": true, "example": "Display name of the power time scheme" }, "PeakHours": { "title": "Boolean[]", "type": "array", "description": "`DEPRECATED. Use instead.` DEPRECATED. Use PeakTimeRanges instead.\n\nA set of 24 boolean flag values, one for each hour of the day. The first\nvalue in the array relates to midnight to 00:59, the next one to 1 AM to\n01:59 and so on, with the last array element relating to 11 PM to 11:59.\nIf the flag is `true` it means that the associated hour of the day\nis considered a peak time; if `false` it means that it is considered\noff-peak.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use instead.", "nullable": true, "items": { "title": "Boolean", "type": "boolean" } }, "PeakTimeRanges": { "title": "String[]", "type": "array", "description": "List of peak time ranges during the day.", "nullable": true, "example": [ "For example", " 00:00-08:00" ], "items": { "title": "String", "type": "string" } }, "PoolSize": { "title": "Int32[]", "type": "array", "description": "`DEPRECATED. Use instead.` DEPRECATED. Use PoolSizeSchedule instead.\n\nA set of 24 integer values, one for each hour of the day. The first value\nin the array relates to midnight to 00:59, the next one to 1 AM to 01:59\nand so on, with the last array element relating to 11 PM to 11:59. The\nvalue defines the number of machines (either as an absolute number or a\npercentage of the machines in the delivery group, depending on the value\nof ) that are to be maintained in a\nrunning state, whether they are in use or not. A value of `-1` has\nspecial meaning: pool size management does not apply during such hours.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use instead.", "nullable": true, "items": { "title": "Int32", "type": "integer", "format": "int32" } }, "PoolSizeSchedule": { "title": "PoolSizeScheduleRequestModel[]", "type": "array", "description": "List of pool size schedules during the day. Each is specified as a\ntime range and an indicator of the number of machines that should be\npowered on during that time range.", "nullable": true, "items": { "$ref": "#/components/schemas/PoolSizeScheduleRequestModel" } }, "PoolUsingPercentage": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the integer values in the pool size array are to be\ntreated as absolute values (if this value is `false`) or as\npercentages of the number of machines in the delivery group (if this value\nis `true`).", "default": false, "nullable": true } } }, "PowerTimeSchemeResponseModel": { "title": "PowerTimeSchemeResponseModel", "type": "object", "description": "Power time scheme.", "additionalProperties": false, "required": [ "DaysOfWeek", "Name", "DisplayName", "Id" ], "properties": { "DaysOfWeek": { "title": "TimeSchemeDays[]", "type": "array", "description": "The pattern of days of the week that the power time scheme covers.", "items": { "$ref": "#/components/schemas/TimeSchemeDays" } }, "Name": { "title": "String", "type": "string", "description": "The administrative name of the power time scheme.", "minLength": 1 }, "DisplayName": { "title": "String", "type": "string", "description": "The name of the power time scheme as displayed in the Studio console.", "minLength": 1 }, "PeakHours": { "title": "Boolean[]", "type": "array", "description": "`DEPRECATED. Use instead.` DEPRECATED. Use PeakTimeRanges instead.\n\nA set of 24 boolean flag values, one for each hour of the day. The\nfirst value in the array relates to 00:00 to 01:00, the next one\nto 01:00 to 02:00 and so on, with the last array element relating to\n23:00 to 00:00. If the flag is `true` it means that the associated\nhour of the day is considered a peak time; if `false` it means that\nit is considered off-peak.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use instead.", "nullable": true, "items": { "title": "Boolean", "type": "boolean" } }, "PeakTimeRanges": { "title": "String[]", "type": "array", "description": "List of peak time ranges during the day.", "nullable": true, "items": { "title": "String", "type": "string" } }, "PoolSize": { "title": "Int32[]", "type": "array", "description": "`DEPRECATED. Use instead.` DEPRECATED. Use PoolSizeSchedule instead.\n\nA set of 24 integer values, one for each hour of the day. The first\nvalue in the array relates to midnight to 00:59, the next one to 1\nAM to 01:59 and so on, with the last array element relating to 11 PM\nto 11:59. The value defines the number of machines (either as an\nabsolute number or a percentage of the machines in the delivery\ngroup, depending on the value of )\nthat are to be maintained in a running state, whether they are in\nuse or not. A value of -1 has special meaning: pool size management\ndoes not apply during such hours.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use instead.", "nullable": true, "items": { "title": "Int32", "type": "integer", "format": "int32" } }, "PoolSizeSchedule": { "title": "PoolSizeScheduleResponseModel[]", "type": "array", "description": "List of pool size schedules during the day. Each is specified as a\ntime range and an indicator of the number of machines that should be\npowered on during that time range.", "nullable": true, "items": { "$ref": "#/components/schemas/PoolSizeScheduleResponseModel" } }, "PoolUsingPercentage": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the integer values in the pool size array are to be\ntreated as absolute values (if this value is `false`) or as\npercentages of the number of machines in the delivery group (if this value\nis `true`)." }, "Id": { "title": "String", "type": "string", "description": "Id of the power time scheme.", "minLength": 1 } } }, "PowerTimeSchemeResponseModelCollection": { "title": "PowerTimeSchemeResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPowerTimeSchemeResponseModel" }, { "type": "object", "description": "Reboot schedule response model collection.", "additionalProperties": false } ] }, "PredefinedPermissionGroupResponseModel": { "title": "PredefinedPermissionGroupResponseModel", "type": "object", "description": "Model for predefined permission group.", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the permission group.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Friendly name of the permission group.", "minLength": 1 } } }, "PredefinedPermissionGroupResponseModelCollection": { "title": "PredefinedPermissionGroupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPredefinedPermissionGroupResponseModel" }, { "type": "object", "description": "Response object for collections of PredefinedPermissionGroupResponseModel.", "additionalProperties": false } ] }, "PredefinedPermissionResponseModel": { "title": "PredefinedPermissionResponseModel", "type": "object", "description": "Response object for a predefined permission", "additionalProperties": false, "required": [ "GroupId", "GroupName", "Id", "Name", "Operations", "IsReadOnly" ], "properties": { "Description": { "title": "String", "type": "string", "description": "The description of the permission. It is usually missed (null or empty).", "nullable": true }, "GroupId": { "title": "String", "type": "string", "description": "The group id of the permission.", "minLength": 1 }, "GroupName": { "title": "String", "type": "string", "description": "The group name of the permission.", "minLength": 1 }, "Id": { "title": "String", "type": "string", "description": "The Id of the permission. It is globally unique.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "The name of the permission. It is a friendly name of permission.", "minLength": 1 }, "Operations": { "title": "String[]", "type": "array", "description": "The list of operations of the permission.", "items": { "title": "String", "type": "string" } }, "IsReadOnly": { "title": "Boolean", "type": "boolean", "description": "Whether any of the operations of the permission may change object status." } } }, "PredefinedPermissionResponseModelCollection": { "title": "PredefinedPermissionResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPredefinedPermissionResponseModel" }, { "type": "object", "description": "Response object for collections of PredefinedPermissionResponseModel.\n ", "additionalProperties": false } ] }, "PreparationType": { "title": "PreparationType", "type": "string", "description": "Types of image preparation.", "x-enumNames": [ "Unknown", "None", "Mcs" ], "enum": [ "Unknown", "None", "Mcs" ] }, "PriorityRefRequestModel": { "title": "PriorityRefRequestModel", "type": "object", "description": "A reference to an object with an associated priority.", "additionalProperties": false, "properties": { "Item": { "title": "String", "type": "string", "description": "Reference to the item.", "nullable": true, "example": "For example, name or Id of an application group" }, "Priority": { "title": "Int32", "type": "integer", "description": "Priority. See the containing object context for\ndetails about how the Priority affects the object\nrelationship.", "format": "int32", "default": 0, "nullable": true } } }, "ProductEdition": { "title": "ProductEdition", "type": "string", "description": "Type of product", "x-enumNames": [ "Unknown", "Platinum", "Enterprise", "Apps", "Vdi", "Advanced", "PRE" ], "enum": [ "Unknown", "Platinum", "Enterprise", "Apps", "Vdi", "Advanced", "PRE" ] }, "ProjectedAutoscaleMachinesResponseModel": { "title": "ProjectedAutoscaleMachinesResponseModel", "type": "object", "description": "Projected number of machines that Autoscale will keep powered on over the specified period", "additionalProperties": false, "required": [ "DesktopGroupId", "ManagedMachineCount", "ProjectedAutoscaleMachines", "TimeZone" ], "properties": { "DesktopGroupId": { "title": "Guid", "type": "string", "description": "The Id of the desired desktop group.", "format": "guid", "minLength": 1 }, "ManagedMachineCount": { "title": "Int32", "type": "integer", "description": "The number of machines in the desktop group that would be managed by Autoscale.\nThis number shall include all the power managed machines in the desktop group, except for machines in maintenance mode or,\nnot tagged for Autoscale if tag restriction is being used.", "format": "int32" }, "ProjectedAutoscaleMachines": { "description": "The number of machines belonging to the desktop group\nthat are expected to be powered on for each 30 minute slot over the specified number of days.", "$ref": "#/components/schemas/ProjectedMachineResponseModel" }, "TimeZone": { "title": "String", "type": "string", "description": "The time zone in which this delivery group's machines reside.", "minLength": 1 } } }, "ProjectedMachineResponseModel": { "title": "ProjectedMachineResponseModel", "type": "object", "description": "Projected Autoscale Machine data.", "additionalProperties": false, "required": [ "ProjectedMachinesForDay" ], "properties": { "ProjectedMachinesForDay": { "title": "ProjectedMachinesPerDayResponseModel[]", "type": "array", "description": "ProjectedMachinesForDay", "items": { "$ref": "#/components/schemas/ProjectedMachinesPerDayResponseModel" } } } }, "ProjectedMachinesPerDayResponseModel": { "title": "ProjectedMachinesPerDayResponseModel", "type": "object", "description": "ProjectedMachinesPerDayResponseModel", "additionalProperties": false, "required": [ "Day", "TimeSlots" ], "properties": { "Day": { "title": "String", "type": "string", "description": "Day", "minLength": 1 }, "TimeSlots": { "title": "ProjectedMachinesTimeSlotResponseModel[]", "type": "array", "description": "TimeSlots", "items": { "$ref": "#/components/schemas/ProjectedMachinesTimeSlotResponseModel" } } } }, "ProjectedMachinesTimeSlotResponseModel": { "title": "ProjectedMachinesTimeSlotResponseModel", "type": "object", "description": "ProjectedMachinesTimeSlotResponseModel", "additionalProperties": false, "required": [ "Time", "PoolSizeCount", "BufferSizeCount" ], "properties": { "Time": { "title": "String", "type": "string", "description": "The start time (in 24-hour clock) for the 30-minute period represented that is based on the time zone of the delivery group.", "minLength": 1 }, "PoolSizeCount": { "title": "Int32", "type": "integer", "description": "The projected machines as per the pool size configured for the current 30 minute period.", "format": "int32" }, "BufferSizeCount": { "title": "Int32", "type": "integer", "description": "The projected machines as per the buffer percentage configured for the current 30 minute period.", "format": "int32" } } }, "ProtocolType": { "title": "ProtocolType", "type": "string", "description": "Protocol types.", "x-enumNames": [ "Unknown", "Hdx", "Rdp", "Console" ], "enum": [ "Unknown", "Hdx", "Rdp", "Console" ] }, "ProvisionedBackupRefResponseModel": { "title": "ProvisionedBackupRefResponseModel", "type": "object", "description": "Reference to a provisioned backup.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the backup.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the backup.", "nullable": true }, "VMSid": { "title": "String", "type": "string", "description": "Provisioned Virtual Machine Sid.", "nullable": true }, "VMName": { "title": "String", "type": "string", "description": "Provisioned virtual machine name on hypervisor.", "nullable": true } } }, "ProvisionedBackupResponseModel": { "title": "ProvisionedBackupResponseModel", "type": "object", "description": "Response model for a provisioned backup of a vm.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the backup.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the backup.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description of the backup.", "nullable": true }, "Version": { "title": "Int32", "type": "integer", "description": "Version of the backup.", "format": "int32" }, "CreationTime": { "title": "String", "type": "string", "description": "Time the backup was created.\nRFC 3339 compatible format.", "nullable": true }, "VMSid": { "title": "String", "type": "string", "description": "Provisioned Virtual Machine Sid.", "nullable": true }, "VMName": { "title": "String", "type": "string", "description": "Provisioned virtual machine name on hypervisor.", "nullable": true }, "VMId": { "title": "String", "type": "string", "description": "Id of the VM, as defined by the hypervisor.", "nullable": true }, "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "Name of the provisioning scheme which the vm is a member of.", "nullable": true }, "ProvisioningSchemeId": { "title": "String", "type": "string", "description": "Id of the provisioning scheme which the vm is a member of.", "nullable": true }, "ProvisionedVmConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The VM configuration version associated to this backup.", "format": "int32", "nullable": true }, "ProvisioningSchemeConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The provisioning scheme configuration version associated to this backup.", "format": "int32" } } }, "ProvisionedBackupResponseModelCollection": { "title": "ProvisionedBackupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisionedBackupResponseModel" }, { "type": "object", "description": "Response object for collections of ProvisionedBackupResponseModel.", "additionalProperties": false } ] }, "ProvisionedBackupRestoreType": { "title": "ProvisionedBackupRestoreType", "type": "string", "description": "Types indicating how the backup being restored.", "x-enumNames": [ "Unknown", "DiskOnly", "RestoreHardware" ], "enum": [ "Unknown", "DiskOnly", "RestoreHardware" ] }, "ProvisionedVirtualMachineConfigurationDeletePreviewResponseModel": { "title": "ProvisionedVirtualMachineConfigurationDeletePreviewResponseModel", "type": "object", "description": "Provisioned virtual machine configuration delete preview response model.", "additionalProperties": false, "properties": { "VMSid": { "title": "String", "type": "string", "description": "Provisioned virtual machine Sid.", "nullable": true }, "Version": { "title": "Int32", "type": "integer", "description": "Provisioned virtual machine configuration version. ", "format": "int32" }, "CanBeDeleted": { "title": "Boolean", "type": "boolean", "description": "If the provisioned virtual machine configuration can be deleted." }, "ImpactedProvisionedBackups": { "title": "ProvisionedBackupRefResponseModel[]", "type": "array", "description": "Impacted provisioned backups.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisionedBackupRefResponseModel" } } } }, "ProvisionedVirtualMachineConfigurationResponseModel": { "title": "ProvisionedVirtualMachineConfigurationResponseModel", "allOf": [ { "$ref": "#/components/schemas/ProvisioningConfigurationBaseResponseModel" }, { "type": "object", "description": "Response model for machine.", "additionalProperties": false, "properties": { "VMSid": { "title": "String", "type": "string", "description": "Provisioned Virtual Machine Sid.", "nullable": true }, "VMName": { "title": "String", "type": "string", "description": "Provisioned virtual machine name on hypervisor.", "nullable": true }, "VMId": { "title": "String", "type": "string", "description": "Id of the VM, as defined by the hypervisor.", "nullable": true }, "IsPersonalizedConfiguration": { "title": "Boolean", "type": "boolean", "description": "Flag indicating if the configuration is persionalized .", "nullable": true } } } ] }, "ProvisionedVirtualMachineConfigurationResponseModelCollection": { "title": "ProvisionedVirtualMachineConfigurationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisionedVirtualMachineConfigurationResponseModel" }, { "type": "object", "description": "Provisioned virtual machine response model collection", "additionalProperties": false } ] }, "ProvisionedVirtualMachineConfigurationResultantSetResponseModel": { "title": "ProvisionedVirtualMachineConfigurationResultantSetResponseModel", "type": "object", "description": "The resultant configuration properties for virtual machines created using Machine Creation Services.\nThis merges properties at the provisioning scheme level with those set on a machine with Set-ProvVM specifically.", "additionalProperties": false, "properties": { "CpuCount": { "title": "Int32", "type": "integer", "description": "The number of processors that VMs will be created with when using this configuration.", "format": "int32", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "The maximum amount of memory that VMs will be created with when using this configuration.", "format": "int32", "nullable": true }, "MachineProfile": { "description": "The machine profile that the scheme uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "ServiceOffering": { "title": "String", "type": "string", "description": "Service offering used by Cloud provisioned VMs.", "nullable": true }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the provisioning scheme that are specific to the target hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "provisioning scheme name", "nullable": true }, "ProvisioningSchemeId": { "title": "Guid", "type": "string", "description": "provisioning scheme uid", "format": "guid" }, "VMId": { "title": "String", "type": "string", "description": "VM Id", "nullable": true }, "VMName": { "title": "String", "type": "string", "description": "VM Name", "nullable": true } } }, "ProvisionedVirtualMachineDetailsResponseModel": { "title": "ProvisionedVirtualMachineDetailsResponseModel", "type": "object", "description": "Response model for machine.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Provisioned Machine Name.", "nullable": true }, "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "Provisioning Scheme Name.", "nullable": true }, "ProvisioningSchemeId": { "title": "String", "type": "string", "description": "Provisioning Scheme Id.", "nullable": true }, "CpuCount": { "title": "Int32", "type": "integer", "description": "Cpu Count.", "format": "int32" }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "Memory in MB.", "format": "int32" }, "Persistency": { "title": "Boolean", "type": "boolean", "description": "Persistency." }, "IdentityType": { "title": "String", "type": "string", "description": "Identity Type.", "nullable": true }, "ProvisioningSchemeVersion": { "title": "Int32", "type": "integer", "description": "Provisioning Scheme Version.", "format": "int32" }, "ImageOutOfDate": { "title": "Boolean", "type": "boolean", "description": "Image Out Of Date." }, "LastBootTime": { "title": "DateTime", "type": "string", "description": "Last Boot Time.", "format": "date-time" }, "CreationTime": { "title": "String", "type": "string", "description": "The date and time when the VM was created.", "nullable": true }, "UseWriteBackCache": { "title": "Boolean", "type": "boolean", "description": "Use Write Back Cache." }, "WriteBackCacheDiskSize": { "title": "Int32", "type": "integer", "description": "Write Back Cache Disk Size.", "format": "int32" }, "WriteBackCacheDriveLetter": { "title": "Char", "type": "string", "description": "Write Back Cache Drive Letter." }, "WriteBackCacheMemorySize": { "title": "Int32", "type": "integer", "description": "Write Back Cache Memory Size.", "format": "int32" }, "Identities": { "title": "String", "type": "string", "description": "Identities.", "nullable": true }, "ProvVMConfigurationVersion": { "title": "Int32", "type": "integer", "description": "Provisioned VM Configuration Version.", "format": "int32", "nullable": true }, "WindowsActivationType": { "title": "String", "type": "string", "description": "Windows Activation Type.", "nullable": true }, "DiskInfo": { "title": "String", "type": "string", "description": "Disk Information.", "nullable": true }, "ImageAndTemplateInfo": { "title": "String", "type": "string", "description": "Image and Template Information.", "nullable": true }, "MCSIOInfo": { "title": "String", "type": "string", "description": "MCS IO information.", "nullable": true }, "NetworkInfo": { "title": "String", "type": "string", "description": "Network Information.", "nullable": true }, "SecurityInfo": { "title": "String", "type": "string", "description": "Security Information.", "nullable": true }, "VMInfo": { "title": "String", "type": "string", "description": "Provisioned VM Information.", "nullable": true }, "ResourcePool": { "description": "The resource pool on which machines are provisioned.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolRefResponseModel" }, "ConfigurationResultantSet": { "description": "The resultant configuration properties for virtual machines created using Machine Creation Services.\nThis merges properties at the provisioning scheme level with those set on a machine with Set-ProvVM specifically.\nIf vm is not executed by Set-ProvVM, it will be null. The configuration properties are same to provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/ProvisionedVirtualMachineConfigurationResultantSetResponseModel" }, "FailureReason": { "title": "String", "type": "string", "description": "Failure reason of power action.", "nullable": true }, "FailedActionCompletionTime": { "title": "String", "type": "string", "description": "Time when the power action failed.", "nullable": true } } }, "ProvisionedVirtualMachineNetworkMapSearchResponseModel": { "title": "ProvisionedVirtualMachineNetworkMapSearchResponseModel", "type": "object", "additionalProperties": false, "properties": { "DeviceId": { "title": "String", "type": "string", "description": "Id of the network mapped device.", "nullable": true }, "NetworkId": { "title": "String", "type": "string", "description": "Network id.", "nullable": true }, "NetworkPath": { "title": "String", "type": "string", "description": "Network inventory XDHyp path.", "nullable": true }, "NetworkName": { "title": "String", "type": "string", "description": "Network name.", "nullable": true } } }, "ProvisionedVirtualMachineSearchFilterGroupRequestModel": { "title": "ProvisionedVirtualMachineSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for machines and sessions", "additionalProperties": false, "properties": { "SearchFilterGroupType": { "description": "The type of search filter group", "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupType" }, "SearchFilters": { "title": "ProvisionedVirtualMachineSearchFilterRequestModel[]", "type": "array", "description": "The search filters in search filter group", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchFilterRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupsType" }, "SearchFilterGroups": { "title": "ProvisionedVirtualMachineSearchFilterGroupRequestModel[]", "type": "array", "description": "The search filter group in search filter groups", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupRequestModel" } } } }, "ProvisionedVirtualMachineSearchFilterGroupsType": { "title": "ProvisionedVirtualMachineSearchFilterGroupsType", "type": "string", "description": "The search filter groups type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "ProvisionedVirtualMachineSearchFilterGroupType": { "title": "ProvisionedVirtualMachineSearchFilterGroupType", "type": "string", "description": "The search filter group type", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "ProvisionedVirtualMachineSearchFilterRequestModel": { "title": "ProvisionedVirtualMachineSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for machines.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true, "example": "For example, test" }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "ProvisionedVirtualMachineSearchProperty": { "title": "ProvisionedVirtualMachineSearchProperty", "type": "string", "description": "Properties which can be used for provisioned virtual machines.\n ", "x-enumNames": [ "ActiveOperation", "VMSid", "CpuCount", "IdentityType", "Identities", "IdentityContent", "ImageOutOfDate", "LastBootTime", "MemoryMB", "Persistency", "ProvisioningSchemeName", "ProvisioningSchemeVersion", "ProvVMConfigurationUpdateVersion", "VMName", "ActivationType", "UseWriteBackCache", "WriteBackCacheDiskSize", "WriteBackCacheMemorySize", "ResourcePoolId", "NetworkId" ], "enum": [ "ActiveOperation", "VMSid", "CpuCount", "IdentityType", "Identities", "IdentityContent", "ImageOutOfDate", "LastBootTime", "MemoryMB", "Persistency", "ProvisioningSchemeName", "ProvisioningSchemeVersion", "ProvVMConfigurationUpdateVersion", "VMName", "ActivationType", "UseWriteBackCache", "WriteBackCacheDiskSize", "WriteBackCacheMemorySize", "ResourcePoolId", "NetworkId" ] }, "ProvisionedVirtualMachineSearchRequestModel": { "title": "ProvisionedVirtualMachineSearchRequestModel", "type": "object", "description": "Request model for defining provisioned virtual machine.", "additionalProperties": false, "properties": { "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the machine.", "nullable": true, "example": "For example, name of a machine" }, "SearchFilters": { "title": "ProvisionedVirtualMachineSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchFilterRequestModel" } }, "SearchFilterGroups": { "title": "ProvisionedVirtualMachineSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupsType" }, "SortCriteriaItems": { "title": "ProvisionedVirtualMachineSortCriteriaRequestModel[]", "type": "array", "description": "Sort criteria for the results, multiple sorting criteria can be specified here.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineSortCriteriaRequestModel" } } } }, "ProvisionedVirtualMachineSearchResponseModel": { "title": "ProvisionedVirtualMachineSearchResponseModel", "type": "object", "description": "Response model for provisioned virtual machine.", "additionalProperties": false, "properties": { "ActiveOperation": { "title": "String", "type": "string", "description": "Active Operation.", "nullable": true }, "VMSid": { "title": "String", "type": "string", "description": "Provisioned Virtual Machine Sid.", "nullable": true }, "CpuCount": { "title": "Int32", "type": "integer", "description": "Cpu Count.", "format": "int32" }, "IdentityType": { "title": "String", "type": "string", "description": "Identity Type:ActiveDirectory, AzureAD, HybridAzureAD, Workgroup.", "nullable": true }, "Identities": { "title": "String", "type": "string", "description": "ActiveDirectory, HybridAzureAD - Domain.\nAzureAD - TenantId.\nWorkgroup - null.", "nullable": true }, "ImageOutOfDate": { "title": "Boolean", "type": "boolean", "description": "Booted image isn't same as assigned image." }, "LastBootTime": { "title": "String", "type": "string", "description": "Last boot time.", "nullable": true }, "CreationTime": { "title": "String", "type": "string", "description": "The date and time when the VM was created.", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "Memory(MB).", "format": "int32" }, "Persistency": { "title": "Boolean", "type": "boolean", "description": "Persistency." }, "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "Provision Scheme Name.", "nullable": true }, "ProvisioningSchemeId": { "title": "String", "type": "string", "description": "Provision Scheme Id", "nullable": true }, "ProvisioningSchemeVersion": { "title": "Int32", "type": "integer", "description": "Provision Scheme Version.", "format": "int32" }, "ProvVMConfigurationUpdateVersion": { "title": "Int32", "type": "integer", "description": "Provisioned Virtual Machine Update Configuration Version.", "format": "int32", "nullable": true }, "VMName": { "title": "String", "type": "string", "description": "Provisioned virtual machine name on hypervisor.", "nullable": true }, "ActivationType": { "description": "Windows Activation Type.", "$ref": "#/components/schemas/WindowsActivationType" }, "UseWriteBackCache": { "title": "Boolean", "type": "boolean", "description": "Whether use write back cache." }, "WriteBackCacheDiskSize": { "title": "Int32", "type": "integer", "description": "Write back cache disk size.", "format": "int32" }, "WriteBackCacheMemorySize": { "title": "Int32", "type": "integer", "description": "Write back cache memory size.", "format": "int32" }, "OperationEvents": { "title": "ProvisioningOperationEventSearchResponseModel[]", "type": "array", "description": "List of ProvisioningOperationEventSearchResponseModel.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningOperationEventSearchResponseModel" } }, "ResourcePoolName": { "title": "String", "type": "string", "description": "Resource pool name.", "nullable": true }, "ResourcePoolId": { "title": "String", "type": "string", "description": "Resource pool id.", "nullable": true }, "NetworkMaps": { "title": "ProvisionedVirtualMachineNetworkMapSearchResponseModel[]", "type": "array", "description": "Network maps.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisionedVirtualMachineNetworkMapSearchResponseModel" } }, "CurrentProvisioningSchemeVersion": { "title": "Int32", "type": "integer", "description": "Provision Scheme Version.", "format": "int32" }, "PowerState": { "description": "Machine power state.", "$ref": "#/components/schemas/PowerState" }, "HypervisorConnectionId": { "title": "String", "type": "string", "description": "Hypervisor connection id.", "nullable": true }, "PropertyUpdateWindowStart": { "title": "String", "type": "string", "description": "Property Update Window Start.", "nullable": true }, "PropertyUpdateWindowEnd": { "title": "String", "type": "string", "description": "Property Update Window End.", "nullable": true }, "SupportedPowerActions": { "title": "SupportedPowerAction[]", "type": "array", "description": "A list of power actions supported by this machine.", "nullable": true, "items": { "$ref": "#/components/schemas/SupportedPowerAction" } }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Denotes if the machine is in maintenance mode.\nMachines in maintenance mode will not accept new sessions." }, "IsBackupServiceOffering": { "title": "Boolean", "type": "boolean", "description": "Denotes if the machine is using a backup service offering." }, "RunningServiceOffering": { "title": "String", "type": "string", "description": "Denotes the machine's running service offering.", "nullable": true }, "ContainerScopes": { "title": "ContainerScopeResponseModel[]", "type": "array", "description": "Delegated admin scopes in which the containers of the\nmachine reside.", "nullable": true, "items": { "$ref": "#/components/schemas/ContainerScopeResponseModel" } }, "ProvisioningSchemeType": { "title": "String", "type": "string", "description": "Provisioning Scheme Type.", "nullable": true }, "LatestActiveProvisioningOperationEventCategory": { "title": "String", "type": "string", "description": "The latest active provisioning operation event category of this machine.", "nullable": true }, "Tasks": { "title": "TaskRefResponseModel[]", "type": "array", "description": "The tasks associated with this VM, currently only unfinished hardware VM update task included.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskRefResponseModel" } } } }, "ProvisionedVirtualMachineSearchResponseModelCollection": { "title": "ProvisionedVirtualMachineSearchResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisionedVirtualMachineSearchResponseModel" }, { "type": "object", "description": "Response object for collections of ProvisionedVirtualMachineSearchResponseModel.", "additionalProperties": false } ] }, "ProvisionedVirtualMachineSortCriteriaRequestModel": { "title": "ProvisionedVirtualMachineSortCriteriaRequestModel", "type": "object", "description": "Machine sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/ProvisionedVirtualMachineSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "ProvisionedVirtualMachineVersionResponseModel": { "title": "ProvisionedVirtualMachineVersionResponseModel", "type": "object", "description": "Response model for machine version.", "additionalProperties": false, "properties": { "VMSid": { "title": "String", "type": "string", "description": "Provisioned Virtual Machine Sid.", "nullable": true }, "VMName": { "title": "String", "type": "string", "description": "Provisioned virtual machine name on hypervisor.", "nullable": true }, "VMId": { "title": "String", "type": "string", "description": "Id of the VM, as defined by the hypervisor.", "nullable": true }, "CpuCount": { "title": "Int32", "type": "integer", "description": "cpu count", "format": "int32", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "Memory in MB", "format": "int32", "nullable": true }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Custom properties", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "MachineProfile": { "description": "The machine profile that the scheme uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "ServiceOffering": { "title": "String", "type": "string", "description": "Service offering used by Cloud provisioned VMs.", "nullable": true }, "Version": { "title": "Int32", "type": "integer", "description": "Provisioning VM version.", "format": "int32" }, "ProvisionedVmConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The VM configuration version associated to this VM version.", "format": "int32", "nullable": true }, "ProvisioningSchemeConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The prov scheme configuration version associated to this VM version.", "format": "int32" }, "NetworkMappings": { "title": "NetworkMapResponseModel[]", "type": "array", "description": "Network mappings.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapResponseModel" } }, "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "provisioning scheme name", "nullable": true }, "ProvisioningSchemeId": { "title": "Guid", "type": "string", "description": "provisioning scheme uid", "format": "guid" }, "WriteBackCacheDiskSize": { "title": "Int32", "type": "integer", "description": "MCSIO WriteBack Cache Disk Size", "format": "int32", "nullable": true }, "WriteBackCacheMemorySize": { "title": "Int32", "type": "integer", "description": "MCSIO WriteBack Cache Memory Size", "format": "int32", "nullable": true }, "State": { "description": "The state of this version.", "$ref": "#/components/schemas/ProvisioningVersionState" }, "CreationTime": { "title": "String", "type": "string", "description": "The creation time of this version.", "nullable": true }, "LastAppliedTime": { "title": "String", "type": "string", "description": "The last applied time of this version.", "nullable": true } } }, "ProvisionedVirtualMachineVersionResponseModelCollection": { "title": "ProvisionedVirtualMachineVersionResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisionedVirtualMachineVersionResponseModel" }, { "type": "object", "description": "Provisioned virtual machine version response model collection", "additionalProperties": false } ] }, "ProvisioningConfigurationBaseResponseModel": { "title": "ProvisioningConfigurationBaseResponseModel", "type": "object", "additionalProperties": false, "properties": { "CpuCount": { "title": "Int32", "type": "integer", "description": "cpu count", "format": "int32", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "Memory in MB", "format": "int32", "nullable": true }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Custom properties", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "MachineProfile": { "description": "The machine profile that the scheme uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "SourceMachineProfile": { "description": "The machine profile that the scheme uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "ServiceOffering": { "title": "String", "type": "string", "description": "Service offering used by Cloud provisioned VMs.", "nullable": true }, "Version": { "title": "Int32", "type": "integer", "description": "Provisioning scheme configuration version. ", "format": "int32" }, "NetworkMappings": { "title": "NetworkMapResponseModel[]", "type": "array", "description": "Network mappings. ", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapResponseModel" } }, "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "provisioning scheme name", "nullable": true }, "ProvisioningSchemeId": { "title": "Guid", "type": "string", "description": "provisioning scheme uid", "format": "guid" }, "Description": { "title": "String", "type": "string", "description": "provisioning scheme version description", "nullable": true }, "WriteBackCacheDiskSize": { "title": "Int32", "type": "integer", "description": "MCSIO WriteBack Cache Disk Size", "format": "int32", "nullable": true }, "WriteBackCacheMemorySize": { "title": "Int32", "type": "integer", "description": "MCSIO WriteBack Cache Memory Size", "format": "int32", "nullable": true }, "State": { "description": "provisioning scheme version's state.", "$ref": "#/components/schemas/ProvisioningConfigurationState" }, "VtpmProvisionPolicy": { "description": "Policy for vTPM provisioning.", "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeVtpmPolicy" }, "CreationTime": { "title": "String", "type": "string", "nullable": true }, "LastAppliedTime": { "title": "String", "type": "string", "nullable": true }, "TaskStatus": { "description": "Task status.", "nullable": true, "$ref": "#/components/schemas/TaskStatus" }, "TaskId": { "title": "Guid", "type": "string", "description": "Task Id.", "format": "guid", "nullable": true } } }, "ProvisioningConfigurationState": { "title": "ProvisioningConfigurationState", "type": "string", "description": "Represents the state of a provsioning configuration.", "x-enumNames": [ "Unknown", "Unused", "InUse", "PreviouslyApplied" ], "enum": [ "Unknown", "Unused", "InUse", "PreviouslyApplied" ] }, "ProvisioningOperationEventConfirmRequestModel": { "title": "ProvisioningOperationEventConfirmRequestModel", "type": "object", "description": "Request model for confirming provisioning operation event.", "additionalProperties": false, "properties": { "EventRecordIds": { "title": "Int64[]", "type": "array", "description": "The array of Event Record Id to confirm.", "nullable": true, "example": [ "For example", " EventRecordIds" ], "items": { "title": "Int64", "type": "integer", "format": "int64" } } } }, "ProvisioningOperationEventSearchFilterGroupRequestModel": { "title": "ProvisioningOperationEventSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for provisioning operation event.", "additionalProperties": false, "properties": { "SearchFilterGroupType": { "description": "The type of search filter group.", "$ref": "#/components/schemas/ProvisioningOperationEventSearchFilterGroupType" }, "SearchFilters": { "title": "ProvisioningOperationEventSearchFilterRequestModel[]", "type": "array", "description": "The search filters in search filter group.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningOperationEventSearchFilterRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups.", "$ref": "#/components/schemas/ProvisioningOperationEventSearchFilterGroupsType" }, "SearchFilterGroups": { "title": "ProvisioningOperationEventSearchFilterGroupRequestModel[]", "type": "array", "description": "The search filter group in search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningOperationEventSearchFilterGroupRequestModel" } } } }, "ProvisioningOperationEventSearchFilterGroupsType": { "title": "ProvisioningOperationEventSearchFilterGroupsType", "type": "string", "description": "The search filter groups type.", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "ProvisioningOperationEventSearchFilterGroupType": { "title": "ProvisioningOperationEventSearchFilterGroupType", "type": "string", "description": "The search filter group type.", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "ProvisioningOperationEventSearchFilterRequestModel": { "title": "ProvisioningOperationEventSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for provisioning operation event.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/ProvisioningOperationEventSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true, "example": "For example, test." }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "ProvisioningOperationEventSearchProperty": { "title": "ProvisioningOperationEventSearchProperty", "type": "string", "description": "Properties which can be used for provisioned virtual machines.\n ", "x-enumNames": [ "EventAdditionalData", "EventCategory", "EventDateTime", "EventMessage", "EventRecordId", "EventSeverity", "EventSource", "EventState", "LinkedObjectType", "LinkedObjectUid", "OperationName", "OperationTargetName", "OperationTargetType", "OperationType", "Recommendation" ], "enum": [ "EventAdditionalData", "EventCategory", "EventDateTime", "EventMessage", "EventRecordId", "EventSeverity", "EventSource", "EventState", "LinkedObjectType", "LinkedObjectUid", "OperationName", "OperationTargetName", "OperationTargetType", "OperationType", "Recommendation" ] }, "ProvisioningOperationEventSearchRequestModel": { "title": "ProvisioningOperationEventSearchRequestModel", "type": "object", "description": "Request model for defining provisioning operation event.", "additionalProperties": false, "properties": { "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the operation event.", "nullable": true, "example": "For example, name of a provisioning operation event." }, "SearchFilters": { "title": "ProvisioningOperationEventSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningOperationEventSearchFilterRequestModel" } }, "SearchFilterGroups": { "title": "ProvisioningOperationEventSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningOperationEventSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups.", "$ref": "#/components/schemas/ProvisioningOperationEventSearchFilterGroupsType" }, "SortCriteriaItems": { "title": "ProvisioningOperationEventSortCriteriaRequestModel[]", "type": "array", "description": "Sort criteria for the results, multiple sorting criteria can be specified here.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningOperationEventSortCriteriaRequestModel" } } } }, "ProvisioningOperationEventSearchResponseModel": { "title": "ProvisioningOperationEventSearchResponseModel", "type": "object", "description": "Response model for provisioned virtual machine.", "additionalProperties": false, "properties": { "LinkedObjectType": { "title": "String", "type": "string", "description": "Linked Object Type.", "nullable": true }, "LinkedObjectUid": { "title": "String", "type": "string", "description": "Linked Object Uid.", "nullable": true }, "EventRecordId": { "title": "Int64", "type": "integer", "description": "Event Record Id.", "format": "int64" }, "EventCategory": { "title": "String", "type": "string", "description": "Event Categaory.", "nullable": true }, "EventSeverity": { "title": "String", "type": "string", "description": "Event Severity.", "nullable": true }, "EventSource": { "title": "String", "type": "string", "description": "Event Source.", "nullable": true }, "EventState": { "title": "String", "type": "string", "description": "Event State.", "nullable": true }, "EventMessage": { "title": "String", "type": "string", "description": "Event Message.", "nullable": true }, "EventDateTime": { "title": "String", "type": "string", "description": "Event Date Time.", "nullable": true }, "EventAdditionalData": { "title": "String", "type": "string", "description": "Event Additional Data.", "nullable": true }, "OperationName": { "title": "String", "type": "string", "description": "Operation Name.", "nullable": true }, "OperationTargetType": { "title": "String", "type": "string", "description": "Operation Target Type.", "nullable": true }, "OperationTargetName": { "title": "String", "type": "string", "description": "Operation Target Name.", "nullable": true }, "OperationType": { "title": "String", "type": "string", "description": "Operation Type.", "nullable": true }, "LinkedObjectName": { "title": "String", "type": "string", "description": "Linked Object Name.", "nullable": true }, "Recommendation": { "title": "String", "type": "string", "description": "Recommendation.", "nullable": true } } }, "ProvisioningOperationEventSearchResponseModelCollection": { "title": "ProvisioningOperationEventSearchResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisioningOperationEventSearchResponseModel" }, { "type": "object", "description": "Response object for collections of ProvisioningOperationEventSearchResponseModel.", "additionalProperties": false } ] }, "ProvisioningOperationEventSortCriteriaRequestModel": { "title": "ProvisioningOperationEventSortCriteriaRequestModel", "type": "object", "description": "Provisioning operation event sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/ProvisioningOperationEventSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "ProvisioningProgressResponseModel": { "title": "ProvisioningProgressResponseModel", "type": "object", "description": "Progress of machine catalog provisioning.", "additionalProperties": false, "required": [ "IsRunning", "Progress" ], "properties": { "IsRunning": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the provisioning task is running." }, "Progress": { "title": "Int32", "type": "integer", "description": "Specifies the current progress of the provisioning task.", "format": "int32" }, "ProgressMessage": { "title": "String", "type": "string", "description": "Specifies the message of current provisioning task.", "nullable": true }, "ProgressMessageList": { "title": "List`1", "type": "array", "nullable": true, "items": { "title": "String[]", "type": "array", "items": { "title": "String", "type": "string" } } } } }, "ProvisioningSchemeConfigurationDeletePreviewResponseModel": { "title": "ProvisioningSchemeConfigurationDeletePreviewResponseModel", "type": "object", "description": "Provisioning scheme configuration delete Preview response model.", "additionalProperties": false, "properties": { "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "Provisioning scheme name", "nullable": true }, "ProvisioningSchemeId": { "title": "Guid", "type": "string", "description": "Provisioning scheme uid", "format": "guid" }, "Version": { "title": "Int32", "type": "integer", "description": "Provisioning scheme configuration version. ", "format": "int32" }, "CanBeDeleted": { "title": "Boolean", "type": "boolean", "description": "If the provisioning scheme configuration can be deleted." }, "ImpactedProvisionedBackups": { "title": "ProvisionedBackupRefResponseModel[]", "type": "array", "description": "Impacted provisioned backups.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisionedBackupRefResponseModel" } } } }, "ProvisioningSchemeConfigurationResponseModel": { "title": "ProvisioningSchemeConfigurationResponseModel", "allOf": [ { "$ref": "#/components/schemas/ProvisioningConfigurationBaseResponseModel" }, { "type": "object", "additionalProperties": false, "properties": { "SecurityGroups": { "title": "SecurityGroup[]", "type": "array", "description": "Security groups.", "nullable": true, "items": { "$ref": "#/components/schemas/SecurityGroup" } } } } ] }, "ProvisioningSchemeConfigurationResponseModelCollection": { "title": "ProvisioningSchemeConfigurationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisioningSchemeConfigurationResponseModel" }, { "type": "object", "description": "Provisioning scheme configuraiton response model collection", "additionalProperties": false } ] }, "ProvisioningSchemeDetailResponseModel": { "title": "ProvisioningSchemeDetailResponseModel", "type": "object", "description": "provisioning scheme detail response model.", "additionalProperties": false, "properties": { "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "ProvisioningSchemeName", "nullable": true }, "ProvisioningSchemeId": { "title": "Guid", "type": "string", "description": "ProvisioningSchemeId", "format": "guid" }, "DiskInfo": { "title": "String", "type": "string", "description": "DiskInfo", "nullable": true }, "ImageAndTemplateInfo": { "title": "String", "type": "string", "description": "ImageAndTemplateInfo", "nullable": true }, "MCSIOInfo": { "title": "String", "type": "string", "description": "MCSIOInfo", "nullable": true }, "NetworkInfo": { "title": "String", "type": "string", "description": "NetworkInfo", "nullable": true }, "SchemeInfo": { "title": "String", "type": "string", "description": "SchemeInfo", "nullable": true }, "SecurityInfo": { "title": "String", "type": "string", "description": "SecurityInfo", "nullable": true }, "Catalogs": { "title": "CatalogInfo[]", "type": "array", "description": "Catalogs using this provisioning scheme", "nullable": true, "items": { "$ref": "#/components/schemas/CatalogInfo" } } } }, "ProvisioningSchemeHardwareUpdateVMOption": { "title": "ProvisioningSchemeHardwareUpdateVMOption", "type": "string", "description": "VM selection option for a provisioning scheme hardware update.", "x-enumNames": [ "AllVMs", "NewVMsOnly" ], "enum": [ "AllVMs", "NewVMsOnly" ] }, "ProvisioningSchemeImageVersionHistoryResponseModel": { "title": "ProvisioningSchemeImageVersionHistoryResponseModel", "type": "object", "description": "Details about an image version specification used for a provisioning scheme.", "additionalProperties": false, "required": [ "ImageVersion" ], "properties": { "ImageVersion": { "description": "Reference to image version on the hypervisor.", "$ref": "#/components/schemas/ImageVersionRefResponseModel" }, "Date": { "title": "String", "type": "string", "description": "The date and time when the snapshot was used in the provisioning scheme.", "nullable": true }, "ImageAssignmentNote": { "title": "String", "type": "string", "description": "The image assignment note when assigning the image version to the provisioning scheme.", "nullable": true }, "IsImageAvailable": { "title": "Boolean", "type": "boolean", "description": "A flag indicating if the image version is still available for this provisioning scheme." } } }, "ProvisioningSchemeMachineAccountResponseModel": { "title": "ProvisioningSchemeMachineAccountResponseModel", "allOf": [ { "$ref": "#/components/schemas/IdentityMachineResponseModel" }, { "type": "object", "description": "Machine identity associated with a provisioning scheme.", "additionalProperties": false, "required": [ "State" ], "properties": { "State": { "description": "The current state of the identity in regards to the provisioning scheme that it is associated with.", "$ref": "#/components/schemas/ProvisioningSchemeMachineAccountState" } } } ] }, "ProvisioningSchemeMachineAccountResponseModelCollection": { "title": "ProvisioningSchemeMachineAccountResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisioningSchemeMachineAccountResponseModel" }, { "type": "object", "description": "Collection of ProvisioningSchemeMachineAccountResponseModel", "additionalProperties": false } ] }, "ProvisioningSchemeMachineAccountState": { "title": "ProvisioningSchemeMachineAccountState", "type": "string", "description": "State of a machine identity in regards to a provisioning scheme which it is associated with.", "x-enumNames": [ "Unknown", "Available", "InUse", "Error", "Tainted", "Locked" ], "enum": [ "Unknown", "Available", "InUse", "Error", "Tainted", "Locked" ] }, "ProvisioningSchemeResponseModel": { "title": "ProvisioningSchemeResponseModel", "type": "object", "description": "Details about how machines in a catalog are provisioned.", "additionalProperties": false, "properties": { "Id": { "title": "Guid", "type": "string", "description": "Id of the provisioning scheme.", "format": "guid" }, "Name": { "title": "String", "type": "string", "description": "Name of the provisioning scheme.", "nullable": true }, "CleanOnBoot": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the VMs that are created will be reset to a clean state on each boot." }, "ControllerAddresses": { "title": "String[]", "type": "array", "description": "The DNS names of the controllers associated with this provisioning scheme for Quick Deploy purposes.", "nullable": true, "items": { "title": "String", "type": "string" } }, "CpuCount": { "title": "Int32", "type": "integer", "description": "The number of processors that VMs will be created with when using this scheme.", "format": "int32" }, "CoresPerCpuCount": { "title": "Int32", "type": "integer", "description": "The number of cores per processor that VMs will be created with when using this scheme.\nThis property only applies when hypervisor connection is Nutanix.", "format": "int32" }, "CurrentDiskImage": { "description": "The current disk image used to provision new machines in the machine catalog.", "nullable": true, "$ref": "#/components/schemas/VMImageResponseModel" }, "HistoricalDiskImages": { "title": "VMImageResponseModel[]", "type": "array", "description": "The historical disk images including current image used to provision new machines\nin the machine catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/VMImageResponseModel" } }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the provisioning scheme that are specific to the target hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ImageRuntimeEnvironment": { "description": "Image runtime environment information.", "nullable": true, "$ref": "#/components/schemas/ImageRuntimeEnvironmentResponseModel" }, "Warning": { "title": "String", "type": "string", "description": "The warning message if parsing CustomProperties with error.", "nullable": true }, "Warnings": { "title": "ProvisioningSchemeWarningReponseModel[]", "type": "array", "description": "The warning.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningSchemeWarningReponseModel" } }, "CustomPropertiesInString": { "title": "String", "type": "string", "description": "The properties of the provisioning scheme that are specific to the target hosting infrastructure in string format.", "nullable": true }, "DedicatedTenancy": { "title": "Boolean", "type": "boolean", "description": "Whether to use dedicated tenancy when creating machines in Cloud Hypervisors." }, "TenancyType": { "title": "String", "type": "string", "description": "Indicates whether to use tenancy type Shared, Instance or Host when creating machines in Cloud Hypervisors.", "nullable": true }, "AzureAdJoinType": { "title": "String", "type": "string", "description": "Indicates whether to use Microsoft Entra join type.", "nullable": true }, "AzureADTenantId": { "title": "Guid", "type": "string", "description": "Microsoft Entra tenant Id associates with this catalog", "format": "guid", "nullable": true }, "ServiceAccountUid": { "title": "String[]", "type": "array", "description": "Service account Uids associated with IdentityPool of this catalog", "nullable": true, "items": { "title": "String", "type": "string" } }, "EntraIDExtensionAttributes": { "title": "Dictionary`2", "type": "object", "description": "The Microsoft Entra ID extension attributes that will be updated on Entra ID devices for the identities within the identity pool of this catalog.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "AzureAdSecurityGroupName": { "title": "String", "type": "string", "description": "Microsoft Entra ID dynamic security group associates with this catalog", "nullable": true }, "IdentityType": { "description": "Indicates whether to use identity type.", "nullable": true, "$ref": "#/components/schemas/IdentityType" }, "DeviceManagementType": { "description": "Indicates whether to use device management type.", "nullable": true, "$ref": "#/components/schemas/DeviceManagementType" }, "IdentityContent": { "title": "String", "type": "string", "description": "The identity content of identity pool.", "nullable": true }, "DiskSizeGB": { "title": "Int32", "type": "integer", "description": "Size of the VM's OS disk, in GB.", "format": "int32" }, "GpuTypeId": { "title": "String", "type": "string", "description": "Type of GPU used for VMs, if any.", "nullable": true }, "ResourcePool": { "description": "The resource pool on which machines are provisioned.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolRefResponseModel" }, "IdentityPool": { "description": "The identity pool that the scheme uses, when determining provisioned VM identity.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "MachineCount": { "title": "Int32", "type": "integer", "description": "Number of machines provisioned from this provisioning scheme.", "format": "int32" }, "MasterImage": { "description": "The VM snapshot that the scheme uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "MachineProfile": { "description": "The machine profile that the scheme uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "SourceMachineProfile": { "title": "String", "type": "string", "description": "The source machine profile that the scheme uses.", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "The maximum amount of memory that VMs will be created with when using this scheme.", "format": "int32" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of provisioning scheme.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "NetworkMaps": { "title": "NetworkMapResponseModel[]", "type": "array", "description": "Networks used by provisioned VMs.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapResponseModel" } }, "NutanixContainer": { "title": "String", "type": "string", "description": "Nutanix container that the scheme uses.", "nullable": true }, "ResetAdministratorPasswords": { "title": "Boolean", "type": "boolean", "description": "Indicates whether administrator passwords are reset automatically to a\nrandom password each time machines are provisioned." }, "SecurityGroups": { "title": "String[]", "type": "array", "description": "Network security groups used by Cloud provisioned VMs.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ServiceOffering": { "title": "String", "type": "string", "description": "Service offering used by Cloud provisioned VMs.", "nullable": true }, "UseFullDiskCloneProvisioning": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the machines are provisioned using the dedicated full disk clone feature." }, "UseWriteBackCache": { "title": "Boolean", "type": "boolean", "description": "True if the scheme will use the write back cache feature." }, "VMMetadata": { "description": "The opaque VM metadata block.", "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeVmMetadataResponseModel" }, "WindowsActivationType": { "title": "String", "type": "string", "description": "Windows Activation Type set on the master image, maybe MultipleActivationKey.", "nullable": true }, "WorkgroupMachines": { "title": "Boolean", "type": "boolean", "description": "True if the provisioned machines are non-domain joined" }, "WriteBackCacheDiskIndex": { "title": "Int32", "type": "integer", "description": "The disk on which to place the write back cache. `0`\nindicates the OS disk.", "format": "int32", "nullable": true }, "WriteBackCacheDiskSizeGB": { "title": "Int32", "type": "integer", "description": "The size of the write back cache disk if specified in GB.", "format": "int32", "nullable": true }, "WriteBackCacheMemorySizeMB": { "title": "Int32", "type": "integer", "description": "The size of the in-memory write back cache if specified in MB.", "format": "int32", "nullable": true }, "WriteBackCacheDriveLetter": { "title": "Char", "type": "string", "description": "Gets or sets the write back cache disk drive letter." }, "IsPreviousImageLegacyVda": { "title": "Boolean", "type": "boolean", "description": "True if the previous image is installed with a legacy VDA." }, "MachineAccountCreationRules": { "description": "Machine account creation rules.", "nullable": true, "$ref": "#/components/schemas/MachineAccountCreationRulesResponseModel" }, "NumAvailableMachineAccounts": { "title": "Int32", "type": "integer", "description": "Number of machine accounts available to be used by machines that will\nbe provisioned in the machine catalog. This will be the identities\nassociated with the machine catalog where\nState is\nAvailable.", "format": "int32" }, "PVSSite": { "title": "String", "type": "string", "description": "PVS Site.", "nullable": true }, "PVSVDisk": { "title": "String", "type": "string", "description": "PVS vDisk.", "nullable": true }, "ProvisioningSchemeType": { "title": "String", "type": "string", "description": "Provisioning scheme type.", "nullable": true }, "CurrentImageVersion": { "description": "Current used image version", "nullable": true, "$ref": "#/components/schemas/ProvisioningSchemeImageVersionHistoryResponseModel" }, "HistoricalImageVersions": { "title": "ProvisioningSchemeImageVersionHistoryResponseModel[]", "type": "array", "description": "The image version of a provision scheme.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningSchemeImageVersionHistoryResponseModel" } }, "DataDisk": { "title": "String", "type": "string", "description": "The data disk used for provisioning scheme.", "nullable": true }, "DataDiskPersistence": { "title": "String", "type": "string", "description": "Indicates whether the data disk is persistent or not.", "nullable": true }, "VtpmProvisionPolicy": { "description": "The vTPM provisioning policy of the provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/VtpmProvisionPolicy" } } }, "ProvisioningSchemeResponseModelCollection": { "title": "ProvisioningSchemeResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisioningSchemeResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "ProvisioningSchemeSearchFilterGroupRequestModel": { "title": "ProvisioningSchemeSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for provisioning scheme.", "additionalProperties": false, "properties": { "SearchFilterGroupType": { "description": "The type of search filter group", "$ref": "#/components/schemas/ProvisioningSchemeSearchFilterGroupType" }, "SearchFilters": { "title": "ProvisioningSchemeSearchFilterRequestModel[]", "type": "array", "description": "The search filters in search filter group", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningSchemeSearchFilterRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/ProvisioningSchemeSearchFilterGroupsType" }, "SearchFilterGroups": { "title": "ProvisioningSchemeSearchFilterGroupRequestModel[]", "type": "array", "description": "The search filter group in search filter groups", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningSchemeSearchFilterGroupRequestModel" } } } }, "ProvisioningSchemeSearchFilterGroupsType": { "title": "ProvisioningSchemeSearchFilterGroupsType", "type": "string", "description": "The search filter groups type.", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "ProvisioningSchemeSearchFilterGroupType": { "title": "ProvisioningSchemeSearchFilterGroupType", "type": "string", "description": "The search filter group type.", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "ProvisioningSchemeSearchFilterRequestModel": { "title": "ProvisioningSchemeSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for provisioning scheme.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/ProvisioningSchemeSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true, "example": "For example, test" }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "ProvisioningSchemeSearchProperty": { "title": "ProvisioningSchemeSearchProperty", "type": "string", "description": "Properties which can be used for provisioning scheme.\n ", "x-enumNames": [ "ActivationType", "Id", "CpuCount", "DiskSize", "IdentityType", "MachineCount", "MemoryMB", "Name", "Persistency", "ProvisioningSchemeType", "ResourcePoolId", "State", "UseWriteBackCache", "Version", "WriteBackCacheDiskSize", "WriteBackCacheMemorySize" ], "enum": [ "ActivationType", "Id", "CpuCount", "DiskSize", "IdentityType", "MachineCount", "MemoryMB", "Name", "Persistency", "ProvisioningSchemeType", "ResourcePoolId", "State", "UseWriteBackCache", "Version", "WriteBackCacheDiskSize", "WriteBackCacheMemorySize" ] }, "ProvisioningSchemeSearchRequestModel": { "title": "ProvisioningSchemeSearchRequestModel", "type": "object", "description": "Request model for defining provisioning scheme.", "additionalProperties": false, "properties": { "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the provisioning scheme.", "nullable": true, "example": "For example, name of a provisioning scheme" }, "SearchFilters": { "title": "ProvisioningSchemeSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningSchemeSearchFilterRequestModel" } }, "SearchFilterGroups": { "title": "ProvisioningSchemeSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningSchemeSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of search filter groups", "$ref": "#/components/schemas/ProvisioningSchemeSearchFilterGroupsType" }, "SortCriteriaItems": { "title": "ProvisioningSchemeSortCriteriaRequestModel[]", "type": "array", "description": "Sort criteria for the results, multiple sorting criteria can be specified here.", "nullable": true, "items": { "$ref": "#/components/schemas/ProvisioningSchemeSortCriteriaRequestModel" } } } }, "ProvisioningSchemeSearchResponseModel": { "title": "ProvisioningSchemeSearchResponseModel", "type": "object", "description": "Response model for provisioning scheme.", "additionalProperties": false, "properties": { "ActivationType": { "description": "Windows Activation Type.", "$ref": "#/components/schemas/WindowsActivationType" }, "CpuCount": { "title": "Int32", "type": "integer", "description": "Cpu Count.", "format": "int32" }, "DiskSize": { "title": "Int32", "type": "integer", "description": "Disk Size.", "format": "int32" }, "Id": { "title": "String", "type": "string", "description": "Provisioning Scheme Id.", "nullable": true }, "IdentityPoolUid": { "title": "Guid", "type": "string", "description": "Identity Pool Uid.", "format": "guid" }, "IdentityType": { "title": "String", "type": "string", "description": "Identity Type:ActiveDirectory, AzureAD, HybridAzureAD, Workgroup.", "nullable": true }, "MachineCount": { "title": "Int32", "type": "integer", "description": "Machine Count.", "format": "int32" }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "Memory(MB).", "format": "int32" }, "Name": { "title": "String", "type": "string", "description": "Provisioning Scheme Name.", "nullable": true }, "Persistency": { "title": "Boolean", "type": "boolean", "description": "Persistency." }, "ProvisioningSchemeType": { "title": "String", "type": "string", "description": "Provisioning Scheme Type.", "nullable": true }, "State": { "title": "String", "type": "string", "description": "Provisioning Scheme State.", "nullable": true }, "UseWriteBackCache": { "title": "Boolean", "type": "boolean", "description": "Whether Use Write Back Cache." }, "WriteBackCacheDiskSize": { "title": "Int32", "type": "integer", "description": "Write Back Cache Disk Size.", "format": "int32" }, "WriteBackCacheMemorySize": { "title": "Int32", "type": "integer", "description": "Use Write Back Cache Memory Size.", "format": "int32" }, "Version": { "title": "Int32", "type": "integer", "description": "Provisioning Scheme Version.", "format": "int32" }, "ResourcePool": { "description": "The resource pool on which machines are provisioned.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourcePoolRefResponseModel" }, "ImageRuntimeEnvironment": { "description": "Image runtime environment information.", "nullable": true, "$ref": "#/components/schemas/ImageRuntimeEnvironmentResponseModel" }, "ServiceOffering": { "title": "String", "type": "string", "description": "Service offering used by Cloud provisioned VMs.", "nullable": true }, "MasterImage": { "description": "The VM snapshot that the scheme uses.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "ImageVersion": { "description": "Current used image version", "nullable": true, "$ref": "#/components/schemas/ImageVersionRefResponseModel" }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "Gets or sets the array of administration scopes", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "WriteBackCacheDiskIndex": { "title": "Int32", "type": "integer", "description": "The disk on which to place the write back cache. `0`\nindicates the OS disk.", "format": "int32", "nullable": true }, "LatestActiveProvisioningOperationEventCategory": { "title": "String", "type": "string", "description": "The latest active provisioning operation event category of this provisioning scheme.", "nullable": true } } }, "ProvisioningSchemeSearchResponseModelCollection": { "title": "ProvisioningSchemeSearchResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfProvisioningSchemeSearchResponseModel" }, { "type": "object", "description": "Response object for collections of ProvisioningSchemeSearchResponseModel.", "additionalProperties": false } ] }, "ProvisioningSchemeSortCriteriaRequestModel": { "title": "ProvisioningSchemeSortCriteriaRequestModel", "type": "object", "description": "Provisioning scheme sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/ProvisioningSchemeSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "ProvisioningSchemeVmMetadataResponseModel": { "title": "ProvisioningSchemeVmMetadataResponseModel", "type": "object", "description": "Provisioning Scheme VMMetadata response model", "additionalProperties": false, "properties": { "MachineSize": { "title": "String", "type": "string", "description": "VmMetadata machine size", "nullable": true }, "OsDiskCaching": { "title": "String", "type": "string", "description": "VmMetadata OS disk cache", "nullable": true }, "Tags": { "title": "String", "type": "string", "description": "VmMetadata tags", "nullable": true }, "BootDiagnostics": { "title": "Boolean", "type": "boolean", "description": "VmMetadata boot diagnostics configuration", "nullable": true }, "AcceleratedNetwork": { "title": "Boolean", "type": "boolean", "description": "VmMetadata accelerated network configuration", "nullable": true }, "SupportsHibernation": { "title": "Boolean", "type": "boolean", "description": "VmMetadata hibernation configuration.", "nullable": true }, "SecurityType": { "title": "String", "type": "string", "description": "VmMetadata security type configuration", "nullable": true }, "DiskSecurityType": { "title": "String", "type": "string", "description": "VmMetadata disk security type configuration", "nullable": true }, "ConfidentialVmDiskEncryptionSetId": { "title": "String", "type": "string", "description": "VmMetadata confidential VM disk encryption set id configuration", "nullable": true }, "EnableSecureBoot": { "title": "Boolean", "type": "boolean", "description": "VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.UefiSettings.secureBootEnabled", "nullable": true }, "EnableVTPM": { "title": "Boolean", "type": "boolean", "description": "VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.UefiSettings.vTpmEnabled", "nullable": true }, "EncryptionAtHost": { "title": "Boolean", "type": "boolean", "description": "VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.EncryptionAtHost", "nullable": true }, "Labels": { "title": "String", "type": "string", "description": "VmMetadata Labels", "nullable": true }, "ZoneName": { "title": "String", "type": "string", "description": "VmMetadata zone name", "nullable": true }, "StorageType": { "title": "String", "type": "string", "description": "VmMetadata storage type", "nullable": true }, "EncryptionKeyId": { "title": "String", "type": "string", "description": "VmMetadata encryption key", "nullable": true } } }, "ProvisioningSchemeVtpmPolicy": { "title": "ProvisioningSchemeVtpmPolicy", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Clone", "Clean" ], "enum": [ "Unknown", "Clone", "Clean" ] }, "ProvisioningSchemeWarningReponseModel": { "title": "ProvisioningSchemeWarningReponseModel", "type": "object", "additionalProperties": false, "properties": { "Type": { "description": "Type of warning.", "$ref": "#/components/schemas/ProvSchemeWarningType" }, "Message": { "title": "String", "type": "string", "description": "Message associated with warning", "nullable": true } } }, "ProvisioningType": { "title": "ProvisioningType", "type": "string", "description": "Types of machine provisioning.", "x-enumNames": [ "Unknown", "Manual", "MCS", "MCSImport", "PVS", "PVSStreaming", "Imported" ], "enum": [ "Unknown", "Manual", "MCS", "MCSImport", "PVS", "PVSStreaming", "Imported" ] }, "ProvisioningVersionState": { "title": "ProvisioningVersionState", "type": "string", "description": "Represents the state of a provisioning version.", "x-enumNames": [ "Unknown", "Unused", "InUse", "PreviouslyApplied" ], "enum": [ "Unknown", "Unused", "InUse", "PreviouslyApplied" ] }, "ProvSchemeWarningType": { "title": "ProvSchemeWarningType", "type": "string", "description": "", "x-enumNames": [ "Unknown", "GetCustomPropertiesFailed", "GetVMMetadataFailed" ], "enum": [ "Unknown", "GetCustomPropertiesFailed", "GetVMMetadataFailed" ] }, "PvsCollectionResponseModel": { "title": "PvsCollectionResponseModel", "type": "object", "description": "PVS collection object.", "additionalProperties": false, "required": [ "Id", "Name", "PvsSite" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the PVS collection.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the PVS collection.", "minLength": 1 }, "Domain": { "title": "String", "type": "string", "description": "Active directory domain of machines in the collection.\ninternally: when querying a collection, get a single device from the\ncollection and get its AD domain.", "nullable": true }, "PvsSite": { "description": "PVS site in which the collection resides.", "$ref": "#/components/schemas/RefResponseModel" } } }, "PvsCollectionResponseModelCollection": { "title": "PvsCollectionResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPvsCollectionResponseModel" }, { "type": "object", "description": "Response object for collections of PvsCollectionResponseModel.", "additionalProperties": false } ] }, "PvsDeviceResponseModel": { "title": "PvsDeviceResponseModel", "type": "object", "description": "PVS device (machine) object.", "additionalProperties": false, "required": [ "Name", "Sid", "PvsSite", "PvsCollection" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Machine name.", "minLength": 1 }, "Sid": { "title": "String", "type": "string", "description": "Machine's Active Directory SID.", "minLength": 1 }, "PvsSite": { "description": "PVS site in which the device resides.", "$ref": "#/components/schemas/RefResponseModel" }, "PvsCollection": { "description": "PVS collection in which the device resides.", "$ref": "#/components/schemas/RefResponseModel" }, "HypervisorConnection": { "title": "String", "type": "string", "description": "Hypervisor connection associated with the machine. Will be set if the caller\nrequested `resolveHypervisor=true` and the machine is located on one of the\nhypervisors connected to the site.", "nullable": true }, "HostedMachineId": { "title": "String", "type": "string", "description": "The unique ID by which the hypervisor recognizes the machine. Will be set if the caller\nrequested `resolveHypervisor=true` and the machine is located on one of the\nhypervisors connected to the site.", "nullable": true } } }, "PvsDeviceResponseModelCollection": { "title": "PvsDeviceResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPvsDeviceResponseModel" }, { "type": "object", "description": "Response object for collections of PvsDeviceResponseModel.", "additionalProperties": false } ] }, "PvsSiteResponseModel": { "title": "PvsSiteResponseModel", "type": "object", "description": "PVS site object.", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the PVS site.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the PVS site.", "minLength": 1 } } }, "PvsSiteResponseModelCollection": { "title": "PvsSiteResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPvsSiteResponseModel" }, { "type": "object", "description": "Response object for collections of PvsSiteResponseModel.", "additionalProperties": false } ] }, "PvsStreamingSiteResponseModel": { "title": "PvsStreamingSiteResponseModel", "type": "object", "description": "PVS site object.", "additionalProperties": false, "properties": { "FarmId": { "title": "String", "type": "string", "description": "Id of the PVS farm.", "nullable": true }, "FarmName": { "title": "String", "type": "string", "description": "Name of the PVS farm.", "nullable": true }, "ResourceLocation": { "title": "String", "type": "string", "description": "Id of the resource location that PVS registered.", "nullable": true }, "SiteId": { "title": "String", "type": "string", "description": "Id of the PVS site.", "nullable": true }, "SiteName": { "title": "String", "type": "string", "description": "Name of the PVS site.", "nullable": true } } }, "PvsStreamingSiteResponseModelCollection": { "title": "PvsStreamingSiteResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPvsStreamingSiteResponseModel" }, { "type": "object", "description": "Response object for collections of PvsStreamingVDiskResponseModel.", "additionalProperties": false } ] }, "PvsStreamingStoreResponseModel": { "title": "PvsStreamingStoreResponseModel", "type": "object", "description": "PVS store object.", "additionalProperties": false, "required": [ "StoreName" ], "properties": { "StoreId": { "title": "String", "type": "string", "description": "Id of the PVS store.", "nullable": true }, "StoreName": { "title": "String", "type": "string", "description": "Name of the PVS store.", "minLength": 1 }, "SiteId": { "title": "String", "type": "string", "description": "Id of the PVS site.", "nullable": true } } }, "PvsStreamingStoreResponseModelCollection": { "title": "PvsStreamingStoreResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPvsStreamingStoreResponseModel" }, { "type": "object", "description": "Response object for collections of PvsStreamingStoreResponseModel.", "additionalProperties": false } ] }, "PvsStreamingVDiskResponseModel": { "title": "PvsStreamingVDiskResponseModel", "type": "object", "description": "PVS vDisk object.", "additionalProperties": false, "required": [ "DiskLocatorName" ], "properties": { "ADPasswordEnabled": { "title": "Boolean", "type": "boolean", "description": "Is AD password enabled.", "nullable": true }, "DiskLocatorId": { "title": "String", "type": "string", "description": "Id of the PVS vDisk.", "nullable": true }, "DiskLocatorName": { "title": "String", "type": "string", "description": "Name of the PVS vDisk.", "minLength": 1 }, "SiteId": { "title": "String", "type": "string", "description": "Id of the PVS site.", "nullable": true }, "SiteName": { "title": "String", "type": "string", "description": "Name of the PVS site.", "nullable": true }, "StoreId": { "title": "String", "type": "string", "description": "Id of the PVS store.", "nullable": true }, "StoreName": { "title": "String", "type": "string", "description": "Name of the PVS store.", "nullable": true }, "StreamingEnabled": { "title": "Boolean", "type": "boolean", "description": "Is streaming enabled.", "nullable": true }, "WriteCacheSize": { "title": "Int32", "type": "integer", "description": "Write cache size of the vDisk.", "format": "int32", "nullable": true }, "WriteCacheType": { "title": "Int32", "type": "integer", "description": "Write cache type of the vDisk.", "format": "int32", "nullable": true } } }, "PvsStreamingVDiskResponseModelCollection": { "title": "PvsStreamingVDiskResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfPvsStreamingVDiskResponseModel" }, { "type": "object", "description": "Response object for collections of PvsStreamingVDiskResponseModel.", "additionalProperties": false } ] }, "ReasonDetail": { "title": "ReasonDetail", "type": "object", "description": "Details for a reason.", "additionalProperties": false, "properties": { "Filter": { "title": "String", "type": "string", "description": "The filter type.", "nullable": true }, "Value": { "title": "String", "type": "string", "description": "The filter value.", "nullable": true }, "Match": { "title": "Boolean", "type": "boolean", "description": "Indicate if the filter matches the given value." } } }, "ReasonStatus": { "title": "ReasonStatus", "type": "string", "description": "The combinations of filter status (allow/deny) and filter conditions indicating the outcome.", "x-enumNames": [ "AllowPositive", "AllowNoMatch", "DenyPositive", "DenyNegative", "AllowInsufficient", "AllowNegative", "PolicyDisabled", "PolicyNoSettings", "PolicyNotFiltered" ], "enum": [ "AllowPositive", "AllowNoMatch", "DenyPositive", "DenyNegative", "AllowInsufficient", "AllowNegative", "PolicyDisabled", "PolicyNoSettings", "PolicyNotFiltered" ] }, "RebootCycleRequestModel": { "title": "RebootCycleRequestModel", "type": "object", "description": "Request object for specifying reboot cycle properties.", "additionalProperties": false, "properties": { "RebootDurationMinutes": { "title": "Int32", "type": "integer", "description": "Approximate maximum number of minutes over which the reboot cycle runs.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "IgnoreMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the reboot cycle is active for maintained machines.", "nullable": true }, "RestrictToTag": { "title": "String", "type": "string", "description": "If set, the reboot cycle only applies to machines in the delivery group with the specified tag.", "nullable": true, "example": "Name or Id of a tag" }, "WarningTitle": { "title": "String", "type": "string", "description": "The window title used when showing the warning message in user sessions on a machine to reboot.", "nullable": true, "example": "For example, warning" }, "WarningMessage": { "title": "String", "type": "string", "description": "Warning message displayed in user sessions on a machine to reboot.", "nullable": true, "example": "For example, warning" }, "WarningDurationMinutes": { "title": "Int32", "type": "integer", "description": "Time prior to the start of a machine reboot at which a warning message is displayed to all the users on the machine.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "WarningRepeatIntervalMinutes": { "title": "Int32", "type": "integer", "description": "Time to wait after the previous reboot warning before displaying the warning message in all user sessions on that machine again.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true } } }, "RebootMachinesRequestModel": { "title": "RebootMachinesRequestModel", "type": "object", "description": "Options for triggering a reboot of all machines in a machine catalog.", "additionalProperties": false, "properties": { "RebootDuration": { "title": "Int32", "type": "integer", "description": "Approximate maximum duration over which the reboot cycle runs, in minutes.", "format": "int32", "default": -1, "nullable": true }, "WarningDuration": { "title": "Int32", "type": "integer", "description": "Time in minutes prior to a machine reboot at which a warning message is\ndisplayed in all user sessions on that machine.", "format": "int32", "default": 0, "nullable": true }, "WarningTitle": { "title": "String", "type": "string", "description": "The window title used when showing the warning message in user sessions\non a machine scheduled for reboot.", "nullable": true, "example": "For example, help desk message" }, "WarningMessage": { "title": "String", "type": "string", "description": "Warning message displayed in user sessions on a machine scheduled for a\nreboot. The optional pattern '%m%' is replaced by the number of minutes\nuntil the reboot.", "nullable": true, "example": "For example, help desk message" }, "WarningRepeatInterval": { "title": "Int32", "type": "integer", "description": "Number of minutes to wait before showing the reboot warning message again.", "format": "int32", "default": 0, "nullable": true } } }, "RebootScheduleDays": { "title": "RebootScheduleDays", "type": "string", "description": "Days to use for a reboot schedule.", "x-enumNames": [ "Unknown", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "enum": [ "Unknown", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] }, "RebootScheduleFrequency": { "title": "RebootScheduleFrequency", "type": "string", "description": "Reboot schedule frequency", "x-enumNames": [ "Unknown", "Daily", "Weekly", "Monthly", "Once" ], "enum": [ "Unknown", "Daily", "Weekly", "Monthly", "Once" ] }, "RebootScheduleRequestModel": { "title": "RebootScheduleRequestModel", "type": "object", "description": "Request object for specifying reboot schedule properties.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the reboot schedule.\nneeds to be globally unique", "nullable": true, "example": "For example, ac8ac87f-d492-440e-a67c-b4b8db08b5df" }, "Name": { "title": "String", "type": "string", "description": "A friendly name for the reboot schedule.", "nullable": true, "example": "Name of the reboot schedule" }, "RebootDurationMinutes": { "title": "Int32", "type": "integer", "description": "Approximate maximum number of minutes over which the scheduled reboot cycle runs.", "format": "int32", "nullable": true }, "Day": { "description": "`DEPRECATED` DEPRECATED. Use DaysInWeek.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED", "nullable": true, "$ref": "#/components/schemas/RebootScheduleDays" }, "DaysInWeek": { "title": "RebootScheduleDays[]", "type": "array", "description": "For weekly cycles, days of the week on which the scheduled reboot cycle starts.", "nullable": true, "items": { "$ref": "#/components/schemas/RebootScheduleDays" } }, "WeekInMonth": { "description": "For monthly cycles, the week of the month on which the scheduled reboot cycle starts.", "nullable": true, "$ref": "#/components/schemas/RebootScheduleWeeks" }, "DayInMonth": { "description": "For monthly cycles, the day of the week on which the scheduled reboot cycle starts.", "nullable": true, "$ref": "#/components/schemas/RebootScheduleDays" }, "Description": { "title": "String", "type": "string", "description": "An optional description for the reboot schedule.", "nullable": true, "example": "Description of the reboot schedule" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the reboot schedule is enabled.", "nullable": true }, "IgnoreMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the reboot schedule is active for maintained machines.", "nullable": true }, "UseNaturalReboot": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the reboot will be a natural reboot, where the machines\nwill be rebooted when they have no sessions.\nOnce UseNaturalReboot is set to true, RebootDurationMinutes won't have any effect.", "nullable": true }, "Frequency": { "description": "Frequency with which this schedule runs.", "nullable": true, "$ref": "#/components/schemas/RebootScheduleFrequency" }, "FrequencyFactor": { "title": "Int32", "type": "integer", "description": "The frequency factor for the schedule.", "format": "int32", "nullable": true }, "RestrictToTag": { "title": "String", "type": "string", "description": "If set, the reboot schedule only applies to machines in the delivery\ngroup with the specified tag.", "nullable": true, "example": "Name or Id of a tag" }, "StartDate": { "title": "String", "type": "string", "description": "The date on which the schedule is expected to firstly run.\nRFC 3339 compatible format.", "nullable": true, "example": "For example, 2019-03-18" }, "StartTime": { "title": "String", "type": "string", "description": "Time of day at which the scheduled reboot cycle starts.\nRFC 3339 compatible format.", "nullable": true, "example": "For example, 2019-03-18T10:58:37+08:00" }, "WarningDurationMinutes": { "title": "Int32", "type": "integer", "description": "Time prior to the start of a machine reboot at which a warning message\nis displayed to all the users on the machine.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "WarningMessage": { "title": "String", "type": "string", "description": "Warning message displayed in user sessions on a machine scheduled for reboot.", "nullable": true, "example": "For example, warning" }, "WarningRepeatIntervalMinutes": { "title": "Int32", "type": "integer", "description": "Time to wait after the previous reboot warning before displaying the warning\nmessage in all user sessions on that machine again.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "WarningTitle": { "title": "String", "type": "string", "description": "The window title used when showing the warning message in user sessions on a\nmachine scheduled for reboot.", "nullable": true, "example": "For example, warning" } } }, "RebootScheduleResponseModel": { "title": "RebootScheduleResponseModel", "type": "object", "description": "Response object for reboot schedule properties.", "additionalProperties": false, "required": [ "Id", "Name", "DeliveryGroup", "RebootDurationMinutes", "Enabled", "IgnoreMaintenanceMode", "Frequency", "StartTime", "WarningDurationMinutes", "WarningRepeatIntervalMinutes" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the reboot schedule.\nneeds to be globally unique", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "A friendly name for the reboot schedule.", "minLength": 1 }, "DeliveryGroup": { "description": "The delivery group to which the reboot schedule is associated.", "$ref": "#/components/schemas/RefResponseModel" }, "RebootDurationMinutes": { "title": "Int32", "type": "integer", "description": "Approximate maximum number of minutes over which the scheduled reboot cycle runs.", "format": "int32" }, "Day": { "description": "`DEPRECATED` DEPRECATED. Use DaysInWeek.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED", "nullable": true, "$ref": "#/components/schemas/RebootScheduleDays" }, "DaysInWeek": { "title": "RebootScheduleDays[]", "type": "array", "description": "For weekly cycles, days of the week on which the scheduled reboot cycle starts.", "nullable": true, "items": { "$ref": "#/components/schemas/RebootScheduleDays" } }, "WeekInMonth": { "description": "For monthly cycles, the week of the month on which the scheduled reboot cycle starts.", "nullable": true, "$ref": "#/components/schemas/RebootScheduleWeeks" }, "DayInMonth": { "description": "For monthly cycles, the day of the week on which the scheduled reboot cycle starts.", "nullable": true, "$ref": "#/components/schemas/RebootScheduleDays" }, "Description": { "title": "String", "type": "string", "description": "An optional description for the reboot schedule.", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the reboot schedule is enabled." }, "IgnoreMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the reboot schedule is active for maintained machines." }, "UseNaturalReboot": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the reboot will be a natural reboot, where the machines\nwill be rebooted when they have no sessions.", "nullable": true }, "Frequency": { "description": "Frequency with which this schedule runs.", "$ref": "#/components/schemas/RebootScheduleFrequency" }, "FrequencyFactor": { "title": "Int32", "type": "integer", "description": "The frequency factor for the schedule.", "format": "int32", "nullable": true }, "RestrictToTag": { "description": "If set, the reboot schedule only applies to machines in the delivery\ngroup with the specified tag.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "StartDate": { "title": "String", "type": "string", "description": "The date on which the schedule is expected to firstly run.\nRFC 3339 compatible format.", "nullable": true }, "StartTime": { "title": "String", "type": "string", "description": "Time of day at which the scheduled reboot cycle starts.\nRFC 3339 compatible format.", "minLength": 1 }, "WarningDurationMinutes": { "title": "Int32", "type": "integer", "description": "Time prior to the start of a machine reboot at which a warning message\nis displayed to all the users on the machine.", "format": "int32" }, "WarningMessage": { "title": "String", "type": "string", "description": "Warning message displayed in user sessions on a machine scheduled for reboot.", "nullable": true }, "WarningRepeatIntervalMinutes": { "title": "Int32", "type": "integer", "description": "Time to wait after the previous reboot warning before displaying the warning\nmessage in all user sessions on that machine again.", "format": "int32" }, "WarningTitle": { "title": "String", "type": "string", "description": "The window title used when showing the warning message in user sessions on a\nmachine scheduled for reboot.", "nullable": true } } }, "RebootScheduleResponseModelCollection": { "title": "RebootScheduleResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfRebootScheduleResponseModel" }, { "type": "object", "description": "Reboot schedule response model collection.", "additionalProperties": false } ] }, "RebootScheduleWeeks": { "title": "RebootScheduleWeeks", "type": "string", "description": "Weeks to use for a reboot schedule.", "x-enumNames": [ "Unknown", "First", "Second", "Third", "Fourth", "Last" ], "enum": [ "Unknown", "First", "Second", "Third", "Fourth", "Last" ] }, "RecommendationModel": { "title": "RecommendationModel", "type": "object", "additionalProperties": false, "properties": { "RecommendationId": { "title": "Guid", "type": "string", "description": "The unique identifier of this recommendation", "format": "guid" }, "RecommendationDescription": { "title": "String", "type": "string", "description": "The full description of this recommendation", "nullable": true }, "RecommendationSource": { "title": "String", "type": "string", "description": "The source of this recommendation", "nullable": true }, "RecommendationType": { "title": "String", "type": "string", "description": "The type of this recommendation.", "nullable": true }, "RecommendationState": { "title": "String", "type": "string", "description": "The state of this recommendation", "nullable": true }, "RecommendationMetadata": { "title": "String", "type": "string", "description": "The metadata associated with this recommendation", "nullable": true }, "Reason": { "title": "String", "type": "string", "description": "The reason why this recommendation was dismissed or rejected by the user", "nullable": true }, "TargetUid": { "title": "Guid", "type": "string", "description": "The unique identifier of the target associated with this recommendation", "format": "guid" }, "TargetName": { "title": "String", "type": "string", "description": "The name of the target associated with this recommendation. E.g. Provisioning Scheme Name", "nullable": true }, "TargetType": { "title": "String", "type": "string", "description": "The type of target associated with this recommendation. E.g. Provisioning Scheme", "nullable": true }, "CreatedDateTimeInUtc": { "title": "String", "type": "string", "description": "The datetime at which this recommendation was generated by the system", "nullable": true }, "UpdatedDateTimeInUtc": { "title": "String", "type": "string", "description": "The datetime at which this recommendation was updated", "nullable": true }, "RemindInDateTimeInUtc": { "title": "String", "type": "string", "description": "The datetime at which this recommendation needs to be reminded", "nullable": true }, "MachineCatalogId": { "title": "Guid", "type": "string", "description": "The machine catalog unique identifier associated with this recommendation", "format": "guid", "nullable": true }, "MachineCatalogName": { "title": "String", "type": "string", "description": "The machine catalog name associated with this recommendation", "nullable": true } } }, "RecommendationResponseModelCollection": { "title": "RecommendationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfRecommendationModel" }, { "type": "object", "description": "Collection of recommendation response models", "additionalProperties": false } ] }, "RecommendationState": { "title": "RecommendationState", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Dismiss", "Accept" ], "enum": [ "Unknown", "Dismiss", "Accept" ] }, "RefResponseModel": { "title": "RefResponseModel", "type": "object", "description": "Response object for an object reference.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the object.\nNeeds to be globally unique\nThis is likely to contain a guid but the property type should be string for future flexibility", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "DEPRECATED. Use Id.", "format": "int32", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the object.", "nullable": true } } }, "RefsRequestModel": { "title": "RefsRequestModel", "type": "object", "description": "Request object allowing caller to specify a list of\nobject references, referenced by ID and/or Name.", "additionalProperties": false, "required": [ "Items" ], "properties": { "Items": { "title": "String[]", "type": "array", "description": "List of item references.", "example": [ "Name of an item" ], "items": { "title": "String", "type": "string" } } } }, "RegistrationState": { "title": "RegistrationState", "type": "string", "description": "Machine registration states.", "x-enumNames": [ "Unknown", "Unregistered", "Initializing", "Registered", "AgentError" ], "enum": [ "Unknown", "Unregistered", "Initializing", "Registered", "AgentError" ] }, "RemotePCEnrollmentScopeCheckModel": { "title": "RemotePCEnrollmentScopeCheckModel", "type": "object", "description": "Enrollment scope for remote PCs.", "additionalProperties": false, "required": [ "Name" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Distinguished name of an OU containing machines allowed to enroll as remote PCs.", "minLength": 1 } } }, "RemotePCEnrollmentScopeRequestModel": { "title": "RemotePCEnrollmentScopeRequestModel", "type": "object", "description": "Enrollment scope for remote PCs.", "additionalProperties": false, "required": [ "OU" ], "properties": { "OU": { "title": "String", "type": "string", "description": "Specifies the DN of an AD container containing machines allowed to enroll as remote PCs.", "maxLength": 64, "minLength": 1, "pattern": ".*|any", "example": "For example, Computers" }, "IncludeSubfolders": { "title": "Boolean", "type": "boolean", "description": "Indicates whether machines in subfolders of OU are allowed to enroll\nas remote PCs.", "default": false, "nullable": true }, "IsOrganizationalUnit": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this objet is for a OU or for a machine", "default": false, "nullable": true }, "MachinesExcluded": { "title": "String[]", "type": "array", "description": "Machines which are explicitly excluded from matching the enrollment scope.", "nullable": true, "example": [ "Name of an excluded machine" ], "items": { "title": "String", "type": "string" } }, "MachinesIncluded": { "title": "String[]", "type": "array", "description": "Machines which are included in the enrollment scope.", "nullable": true, "example": [ "Name of an included machine" ], "items": { "title": "String", "type": "string" } }, "AssignedUsers": { "title": "String[]", "type": "array", "description": "The user(s) to whom this machine will be assigned. Machines can be assigned\nto multiple users, a single client IP address, or a single client name, but only to\none of these categories at a time.", "nullable": true, "example": [ "Name of an assigned user" ], "items": { "title": "String", "type": "string" } } } }, "RemotePCEnrollmentScopeResponseModel": { "title": "RemotePCEnrollmentScopeResponseModel", "type": "object", "description": "Enrollment scope for remote PCs.", "additionalProperties": false, "required": [ "OU" ], "properties": { "OU": { "title": "String", "type": "string", "description": "Specifies the DN of an AD container containing machines allowed to enroll as remote PCs.", "maxLength": 64, "minLength": 1, "pattern": ".*|any" }, "IncludeSubfolders": { "title": "Boolean", "type": "boolean", "description": "Indicates whether machines in subfolders of OU are allowed to enroll\nas remote PCs.", "default": false, "nullable": true }, "IsOrganizationalUnit": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this objet is for a OU or for a machine", "default": false, "nullable": true }, "MachinesExcluded": { "title": "String[]", "type": "array", "description": "Machines which are explicitly excluded from matching the enrollment scope.", "nullable": true, "items": { "title": "String", "type": "string" } }, "MachinesIncluded": { "title": "String[]", "type": "array", "description": "Machines which are included in the enrollment scope.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "RequiredSleepCapability": { "title": "RequiredSleepCapability", "type": "string", "description": "The sleep capability of this desktop group.\n ", "x-enumNames": [ "Unknown", "None", "Suspend" ], "enum": [ "Unknown", "None", "Suspend" ] }, "ReservationResponseModel": { "title": "ReservationResponseModel", "type": "object", "description": "The response object indicating the reservation.", "additionalProperties": false, "properties": { "Term": { "title": "String", "type": "string", "description": "Gets or sets the term.\nSuch as '1 Year' and '3 Years'.", "nullable": true }, "EffectivePrice": { "title": "Decimal", "type": "number", "description": "Gets or sets the effective price.", "format": "decimal", "nullable": true }, "RetailPrice": { "title": "Decimal", "type": "number", "description": "Gets or sets the retail price.", "format": "decimal", "nullable": true }, "Currency": { "title": "String", "type": "string", "description": "Gets or sets the currency.", "nullable": true } } }, "ResourceAccessPolicyRequestModel": { "title": "ResourceAccessPolicyRequestModel", "type": "object", "description": "Request object for creating or updating a resource access policy rule.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the resource access policy rule.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description of the resource access policy rule.", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the resource access policy rule is enabled. If a policy rule is disabled\nit is not considered when evaluating resource access.", "default": true, "nullable": true }, "ExcludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the ExcludedSmartAccessTags\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "nullable": true }, "ExcludedSmartAccessTags": { "title": "SmartAccessTagRequestModel[]", "type": "array", "description": "Specifies the SmartAccess tags which will be denied access to\nthe resource.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagRequestModel" } }, "IncludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedSmartAccessTags\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "nullable": true }, "IncludedSmartAccessTags": { "title": "SmartAccessTagRequestModel[]", "type": "array", "description": "Specifies the SmartAccess tags which grant access to\nthe resource.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagRequestModel" } }, "IncludedSmartAccessFilterType": { "description": "Indicates whether all tags present in IncludedSmartAccessTags must\nmatch tags provided by the user's connection to grant access (MatchAll),\nor whether any tag matching is sufficient(MatchAny).", "nullable": true, "$ref": "#/components/schemas/FilterMatchType" }, "ResourceType": { "description": "The type of resource this policy rule applies to.", "nullable": true, "$ref": "#/components/schemas/ResourceAccessPolicyResourceType" }, "TagUid": { "title": "Int32", "type": "integer", "description": "The UID of the tag associated with this policy rule.", "format": "int32", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Additional metadata for the resource access policy rule.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "ResourceAccessPolicyResourceType": { "title": "ResourceAccessPolicyResourceType", "type": "string", "description": "Specifies the type of resource that a resource access policy rule applies to.", "x-enumNames": [ "Unknown", "Application", "Desktop", "Content" ], "enum": [ "Unknown", "Application", "Desktop", "Content" ] }, "ResourceAccessPolicyResponseModel": { "title": "ResourceAccessPolicyResponseModel", "type": "object", "description": "Response object for a resource access policy rule", "additionalProperties": false, "properties": { "Id": { "title": "Int32", "type": "integer", "description": "Uid of the resouce access policy rule.", "format": "int32" }, "Name": { "title": "String", "type": "string", "description": "Name of the resource access policy rule.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description of the resource access policy rule.", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the resource access policy rule is enabled. If a policy rule is disabled\nit is not considered when evaluating resource access." }, "ExcludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the excluded SmartAccess filter is enabled.\nIf the filter is disabled, it is ignored when the access policy is evaluated." }, "ExcludedSmartAccessTags": { "title": "SmartAccessTagResponseModel[]", "type": "array", "description": "Specifies the SmartAccess tags which will be denied access to resources.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagResponseModel" } }, "IncludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the included SmartAccess filter is enabled.\nIf the filter is disabled, it is ignored when the access policy is evaluated." }, "IncludedSmartAccessFilterType": { "description": "Specifies the type of SmartAccess filter for included tags.", "nullable": true, "$ref": "#/components/schemas/FilterMatchType" }, "IncludedSmartAccessTags": { "title": "SmartAccessTagResponseModel[]", "type": "array", "description": "Specifies the SmartAccess tags which will be allowed access to resources.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagResponseModel" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Additional metadata for the resource access policy rule.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ResourceType": { "description": "The type of resource this policy rule applies to.", "nullable": true, "$ref": "#/components/schemas/ResourceAccessPolicyResourceType" }, "TagName": { "title": "String", "type": "string", "description": "The name of the tag associated with this policy rule.", "nullable": true }, "TagUid": { "title": "Int32", "type": "integer", "description": "The UID of the tag associated with this policy rule.", "format": "int32", "nullable": true } } }, "ResourceAccessPolicyResponseModelCollection": { "title": "ResourceAccessPolicyResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfResourceAccessPolicyResponseModel" }, { "type": "object", "description": "Resource access policy response model collection", "additionalProperties": false } ] }, "ResourceCostItemResponseModel": { "title": "ResourceCostItemResponseModel", "type": "object", "description": "The response model for the resource cost item.", "additionalProperties": false, "properties": { "Resource": { "title": "String", "type": "string", "description": "Specifies the resource for which the cost is calculated.", "nullable": true }, "Cost": { "title": "Decimal", "type": "number", "description": "The cost of the resource.", "format": "decimal" }, "Currency": { "title": "String", "type": "string", "description": "The currency of the cost.", "nullable": true } } }, "ResourceCostResponseModelCollection": { "title": "ResourceCostResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfResourceCostItemResponseModel" }, { "type": "object", "description": "The response model for the resource cost.", "additionalProperties": false } ] }, "ResourcePriceResponseModel": { "title": "ResourcePriceResponseModel", "type": "object", "description": "The response object indicating the price of a resource.", "additionalProperties": false, "properties": { "Location": { "title": "String", "type": "string", "description": "Gets or sets the location.", "nullable": true }, "EffectivePrice": { "description": "Gets or sets the effective price.", "nullable": true, "$ref": "#/components/schemas/UnitPriceResponseModel" }, "RetailPrice": { "description": "Gets or sets the retail price.", "nullable": true, "$ref": "#/components/schemas/UnitPriceResponseModel" }, "SavingPlans": { "title": "SavingPlanResponseModel[]", "type": "array", "description": "Gets or sets the savings plans.", "nullable": true, "items": { "$ref": "#/components/schemas/SavingPlanResponseModel" } }, "Reservations": { "title": "ReservationResponseModel[]", "type": "array", "description": "Gets or sets the reservations.", "nullable": true, "items": { "$ref": "#/components/schemas/ReservationResponseModel" } }, "AdditionalData": { "title": "IDictionary`2", "type": "object", "description": "Gets or sets the additional data.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } } } }, "ResourceValidationCategory": { "title": "ResourceValidationCategory", "type": "string", "description": "The resource validation category.", "x-enumNames": [ "MachineProfile", "HibernationSupport" ], "enum": [ "MachineProfile", "HibernationSupport" ] }, "ResourceValidationReportModel": { "title": "ResourceValidationReportModel", "type": "object", "description": "The validation report.", "additionalProperties": false, "properties": { "Category": { "description": "The validation category.", "$ref": "#/components/schemas/ResourceValidationCategory" }, "Result": { "description": "The validation result.", "$ref": "#/components/schemas/ResourceValidationResult" }, "Violations": { "title": "ResourceValidationViolationModel[]", "type": "array", "description": "A list of violations.", "nullable": true, "items": { "$ref": "#/components/schemas/ResourceValidationViolationModel" } } } }, "ResourceValidationResult": { "title": "ResourceValidationResult", "type": "string", "description": "The resource validation result.", "x-enumNames": [ "Passed", "PassedWithWarning", "Failed" ], "enum": [ "Passed", "PassedWithWarning", "Failed" ] }, "ResourceValidationViolationModel": { "title": "ResourceValidationViolationModel", "type": "object", "description": "A resource validation violation entry.", "additionalProperties": false, "required": [ "Level", "Message" ], "properties": { "Level": { "description": "Severe Level of the violation.", "$ref": "#/components/schemas/ResourceViolationLevel" }, "Message": { "title": "String", "type": "string", "description": "A violation message.", "minLength": 1 }, "Detail": { "title": "String", "type": "string", "description": "The attached detail, could be null.", "nullable": true }, "RelativePath": { "title": "String", "type": "string", "description": "The relative path of the resource which owns this violation, could be null.", "nullable": true } } }, "ResourceViolationLevel": { "title": "ResourceViolationLevel", "type": "string", "description": "Resource Validation Level.", "x-enumNames": [ "Error", "Warn" ], "enum": [ "Error", "Warn" ] }, "RestApiStatus": { "title": "RestApiStatus", "type": "string", "description": "Orchestration RESTFul API status.", "x-enumNames": [ "Unknown", "Starting", "Started", "Stopping", "Stopped" ], "enum": [ "Unknown", "Starting", "Started", "Stopping", "Stopped" ] }, "RestartGeneralTaskRequestModel": { "title": "RestartGeneralTaskRequestModel", "allOf": [ { "$ref": "#/components/schemas/RestartTaskRequestModel" }, { "type": "object", "additionalProperties": false } ] }, "RestartMaintenanceCycleTaskRequestModel": { "title": "RestartMaintenanceCycleTaskRequestModel", "allOf": [ { "$ref": "#/components/schemas/RestartTaskRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "ScheduledStartTime", "MaxDurationInMinutes" ], "properties": { "ScheduledStartTime": { "title": "String", "type": "string", "description": "Start time for task.\nRFC 3339 compatible format.", "minLength": 1 }, "MaxDurationInMinutes": { "title": "Int32", "type": "integer", "description": "The maximum duration allowed for task ", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 } } } ] }, "RestartTaskRequestModel": { "title": "RestartTaskRequestModel", "type": "object", "description": "Restart task details.", "additionalProperties": false, "required": [ "Type" ], "properties": { "Type": { "description": "Type of task. Required", "$ref": "#/components/schemas/TaskType" }, "ScheduledStartTime": { "title": "String", "type": "string", "description": "Start time for task.\nRFC 3339 compatible format.", "minLength": 1 }, "MaxDurationInMinutes": { "title": "Int32", "type": "integer", "description": "The maximum duration allowed for task ", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 } } }, "RestoreVmBackupTaskDetailResponseModel": { "title": "RestoreVmBackupTaskDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/MaintenanceCycleTaskDetailResponseModel" }, { "type": "object", "description": "Response object for a task of restore vm backup.", "additionalProperties": false, "properties": { "ProvisionedBackupId": { "title": "String", "type": "string", "description": "The id of the backup.", "nullable": true }, "ProvisionedBackupRestoreType": { "description": "The type of how the backup being restored.", "$ref": "#/components/schemas/ProvisionedBackupRestoreType" } } } ] }, "RoleResponseModel": { "title": "RoleResponseModel", "type": "object", "description": "Response object for a delegated admin role.", "additionalProperties": false, "required": [ "Id", "Name", "IsBuiltIn" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of role.\nNeeds to be made globally unique (perhaps add site id)", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of role.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of role.", "nullable": true }, "IsBuiltIn": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the role is built-in." }, "IsTenantAdminRole": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the role is for tenant admin." }, "CanLaunchManage": { "title": "Boolean", "type": "boolean", "description": "Indicate that if the management page could be launch on xdconsole", "nullable": true }, "CanLaunchMonitor": { "title": "Boolean", "type": "boolean", "description": "Indicate that if the monitor page could be launch on xdconsole", "nullable": true }, "Permissions": { "title": "DelegatedAdminPermissionResponseModel[]", "type": "array", "description": "List of permissions granted by the role.", "nullable": true, "items": { "$ref": "#/components/schemas/DelegatedAdminPermissionResponseModel" } } } }, "RoleResponseModelCollection": { "title": "RoleResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfRoleResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "RolloutStrategy": { "title": "RolloutStrategy", "type": "string", "description": "Specifies how updated images are applied to existing VMs in a catalog.", "x-enumNames": [ "Unknown", "UpdateOnNaturalReboot", "UpdateDuringServiceWindow" ], "enum": [ "Unknown", "UpdateOnNaturalReboot", "UpdateDuringServiceWindow" ] }, "SavingPlanResponseModel": { "title": "SavingPlanResponseModel", "type": "object", "description": "The response object indicating the saving plan.", "additionalProperties": false, "properties": { "Term": { "title": "String", "type": "string", "description": "Gets or sets the term.", "nullable": true }, "EffectivePrice": { "title": "Decimal", "type": "number", "description": "Gets or sets the effective price.", "format": "decimal", "nullable": true }, "RetailPrice": { "title": "Decimal", "type": "number", "description": "Gets or sets the retail price.", "format": "decimal", "nullable": true } } }, "ScheduleDetailResponseModel": { "title": "ScheduleDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleResponseModel" }, { "type": "object", "description": "Response object for a schedule.", "additionalProperties": false, "properties": { "Type": { "description": "Type of schedule", "$ref": "#/components/schemas/TaskType" } } } ] }, "ScheduledReboot": { "title": "ScheduledReboot", "type": "string", "description": "Scheduled reboot states.", "x-enumNames": [ "Unknown", "None", "Pending", "Draining", "InProgress", "Natural" ], "enum": [ "Unknown", "None", "Pending", "Draining", "InProgress", "Natural" ] }, "ScheduledTaskFrequency": { "title": "ScheduledTaskFrequency", "type": "string", "description": "Backup Restore Schedule Frequency", "x-enumNames": [ "Daily", "Weekly", "Monthly", "Once", "NotDefined" ], "enum": [ "Daily", "Weekly", "Monthly", "Once", "NotDefined" ] }, "ScheduleMaintenanceCycleTaskRequestModel": { "title": "ScheduleMaintenanceCycleTaskRequestModel", "type": "object", "description": "Request object to schedule a MCS Maintenance Cycle.", "additionalProperties": false, "properties": { "Description": { "title": "String", "type": "string", "description": "The description of the Maintenance Cycle.", "maxLength": 512, "nullable": true }, "ScheduledStartTime": { "title": "String", "type": "string", "description": "Maintenance cycle start time, if it is not set, the operation will start now.\nRFC 3339 compatible format.", "nullable": true }, "MaxDurationInMinutes": { "title": "Int32", "type": "integer", "description": "The max duration allowed for maintenance cycle.", "format": "int32", "nullable": true }, "PurgeDBAfterInDays": { "title": "Int32", "type": "integer", "description": "Purge history data after a certain number of days.", "format": "int32", "nullable": true }, "SessionWarningLogOffTitle": { "title": "String", "type": "string", "description": "The title of session log off warning. ", "maxLength": 512, "nullable": true }, "SessionWarningLogOffMessage": { "title": "String", "type": "string", "description": "The message of session log off warning.", "maxLength": 512, "nullable": true }, "SessionWarningTimeInMinutes": { "title": "Int32", "type": "integer", "description": "The countdown duration for session log off. ", "format": "int32", "nullable": true } } }, "ScheduleProvisionedVMTaskDetailResetOSDiskRequestModel": { "title": "ScheduleProvisionedVMTaskDetailResetOSDiskRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleMaintenanceCycleTaskRequestModel" }, { "type": "object", "description": "Request object for schedule a maintenance cycle to reset os disk for provisioned virtual machines.", "additionalProperties": false, "required": [ "VirtualMachines" ], "properties": { "ProvisioningScheme": { "title": "String", "type": "string", "description": "The name or id of provisioning scheme.", "nullable": true }, "VirtualMachines": { "title": "String[]", "type": "array", "description": "The name or sid of provisioned virtual machines.", "items": { "title": "String", "type": "string" } } } } ] }, "ScheduleProvisionedVMTaskDetailRestoreBackupRequestModel": { "title": "ScheduleProvisionedVMTaskDetailRestoreBackupRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleMaintenanceCycleTaskRequestModel" }, { "type": "object", "description": "Request object for schedule a maintenance cycle to restore provisioned virtual machine to the backup.", "additionalProperties": false, "required": [ "ProvisionedBackupId" ], "properties": { "ProvisionedBackupId": { "title": "String", "type": "string", "description": "The id of the backup.", "maxLength": 36, "minLength": 1, "pattern": "^([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$" }, "ProvisionedBackupRestoreType": { "description": "The type of how the backup being restored.", "$ref": "#/components/schemas/ProvisionedBackupRestoreType" } } } ] }, "ScheduleProvisionedVMTaskDetailTakeBackupRequestModel": { "title": "ScheduleProvisionedVMTaskDetailTakeBackupRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleTaskDetailTakeBackupBaseRequestModel" }, { "type": "object", "description": "Request object for schedule a maintenance cycle to taking backup for provisioned virtual machines.", "additionalProperties": false, "required": [ "VirtualMachines" ], "properties": { "ProvisioningScheme": { "title": "String", "type": "string", "description": "The name or id of provisioning scheme.", "nullable": true }, "VirtualMachines": { "title": "String[]", "type": "array", "description": "The name or sid of provisioned virtual machines.", "items": { "title": "String", "type": "string" } } } } ] }, "ScheduleProvisionedVMTaskHardwareUpdateBaseRequestModel": { "title": "ScheduleProvisionedVMTaskHardwareUpdateBaseRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleMaintenanceCycleTaskRequestModel" }, { "type": "object", "description": "Base request object for scheduling a prov VM hardware update.", "additionalProperties": false } ] }, "ScheduleProvisionedVMTaskHardwareUpdateRequestModel": { "title": "ScheduleProvisionedVMTaskHardwareUpdateRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleProvisionedVMTaskHardwareUpdateBaseRequestModel" }, { "type": "object", "description": "Request object for scheduling a prov VM hardware update.", "additionalProperties": false, "properties": { "ProvisionedVmConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The version of provisioning VM configuration.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "nullable": true }, "ProvisioningSchemeConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The version of provisioning scheme configuration.", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0, "nullable": true } } } ] }, "ScheduleProvisioningSchemeTaskDetailTakeBackupRequestModel": { "title": "ScheduleProvisioningSchemeTaskDetailTakeBackupRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleTaskDetailTakeBackupBaseRequestModel" }, { "type": "object", "description": "Request object for schedule a maintenance cycle to taking backup for the provisioning scheme.", "additionalProperties": false } ] }, "ScheduleProvisioningSchemeTaskHardwareUpdateRequestModel": { "title": "ScheduleProvisioningSchemeTaskHardwareUpdateRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleMaintenanceCycleTaskRequestModel" }, { "type": "object", "description": "Request object for creation of prov scheme hardware update.", "additionalProperties": false, "required": [ "ProvisioningSchemeConfigurationVersion", "VMOption" ], "properties": { "ProvisioningSchemeConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The version of provisioning scheme configuration.", "format": "int32", "maximum": 2147483647.0, "minimum": 1.0 }, "VMOption": { "description": "The VM option for the hardware update in the provisioning scheme. Can be all VMs or new VMs only.", "$ref": "#/components/schemas/ProvisioningSchemeHardwareUpdateVMOption" }, "BypassPreflightCheck": { "title": "Boolean", "type": "boolean", "description": "Flag indicating if bypass preglith check for VMs in the provisioning scheme.\nOptional. Default is `false`.", "default": false } } } ] }, "ScheduleProvisioningSchemeTaskImageUpdateRequestModel": { "title": "ScheduleProvisioningSchemeTaskImageUpdateRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleMaintenanceCycleTaskRequestModel" }, { "type": "object", "description": "Request object for creation of provisioning scheme image update.", "additionalProperties": false, "properties": { "MasterImagePath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine snapshot\nor VM template that will be used. This identifies the hard disk\nto be used and the default values for the memory and processors.\nThis must be a path to a Snapshot or Template item in the\nresource pool to which the Machine Catalog is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, {vm name}.vm/{snapshot name}.snapshot" }, "AssignImageVersionToProvisioningScheme": { "description": "Image version assignment to this provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/AssignImageVersionToProvisioningSchemeBaseRequestModel" }, "RolloutStrategy": { "description": "Rollout strategy for updating VMs with the new image.", "$ref": "#/components/schemas/RolloutStrategy" } } } ] }, "ScheduleResponseModel": { "title": "ScheduleResponseModel", "type": "object", "description": "Response object for a scheduled task.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Scheduled task Id.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name", "nullable": true }, "Type": { "description": "Scheduled task type.", "$ref": "#/components/schemas/TaskType" }, "Description": { "title": "String", "type": "string", "description": "Description of the scheduled task.", "nullable": true }, "TargetType": { "description": "The target type of the scheduled task. Different types of tasks may have different targets.Also Targets.", "$ref": "#/components/schemas/TaskTargetType" }, "Targets": { "title": "RefResponseModel[]", "type": "array", "description": "The targets of the scheduled task. Different types of tasks may have different targets. Also TargetType.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "StartTime": { "title": "String", "type": "string", "description": "The start time for the task.", "nullable": true }, "CreatedBy": { "title": "String", "type": "string", "description": "The user who created the task.", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates if the task is enabled." }, "Frequency": { "description": "The frequency of the task. Different types of tasks may have different frequencies.", "$ref": "#/components/schemas/ScheduledTaskFrequency" } } }, "ScheduleResponseModelCollection": { "title": "ScheduleResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfScheduleResponseModel" }, { "type": "object", "additionalProperties": false } ] }, "ScheduleSearchFilterGroupRequestModel": { "title": "ScheduleSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for schedules.", "additionalProperties": false, "properties": { "SearchFilters": { "title": "ScheduleSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/ScheduleSearchFilterRequestModel" } }, "SearchFilterGroupType": { "description": "The type of how the search filter in SearchFilters are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" }, "SearchFilterGroups": { "title": "ScheduleSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/ScheduleSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of how the search filter groups in SearchFilterGroups are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" } } }, "ScheduleSearchFilterRequestModel": { "title": "ScheduleSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for schedules.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/ScheduleSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "ScheduleSearchProperty": { "title": "ScheduleSearchProperty", "type": "string", "description": "Defines properties for searching schedules.", "x-enumNames": [ "Unknown", "Id", "Name", "Description", "StartTime", "Type", "TargetType", "Enabled", "Frequency" ], "enum": [ "Unknown", "Id", "Name", "Description", "StartTime", "Type", "TargetType", "Enabled", "Frequency" ] }, "ScheduleSearchRequestModel": { "title": "ScheduleSearchRequestModel", "type": "object", "description": "Request model for defining advanced schedule search criteria.", "additionalProperties": false, "properties": { "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the schedule.", "nullable": true }, "SearchFilters": { "title": "ScheduleSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/ScheduleSearchFilterRequestModel" } }, "SortCriteria": { "description": "Sort criteria for the results.", "nullable": true, "$ref": "#/components/schemas/ScheduleSortCriteriaRequestModel" }, "SearchFilterGroups": { "title": "ScheduleSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/ScheduleSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of how the search filter groups in SearchFilterGroups are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" }, "SortCriteriaItems": { "title": "ScheduleSortCriteriaRequestModel[]", "type": "array", "description": "Sort criteria for the results, multiple sorting criteria can be specified here.", "nullable": true, "items": { "$ref": "#/components/schemas/ScheduleSortCriteriaRequestModel" } } } }, "ScheduleSortCriteriaRequestModel": { "title": "ScheduleSortCriteriaRequestModel", "type": "object", "description": "Schedule sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/ScheduleSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "ScheduleTaskDetailTakeBackupBaseRequestModel": { "title": "ScheduleTaskDetailTakeBackupBaseRequestModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleMaintenanceCycleTaskRequestModel" }, { "type": "object", "description": "Base object of request for schedule a maintenance cycle to taking backup.", "additionalProperties": false, "properties": { "ProvisionedBackupName": { "title": "String", "type": "string", "description": "The name of the backup.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "ProvisionedBackupDescription": { "title": "String", "type": "string", "description": "The description of the backup.", "maxLength": 512, "pattern": "(.*)*", "nullable": true }, "ShutdownMachines": { "title": "Boolean", "type": "boolean", "description": "Whether to shutdown the virtual machine when taking backup.", "default": true, "nullable": true } } } ] }, "ScopedObjectRequestModel": { "title": "ScopedObjectRequestModel", "type": "object", "description": "A scoped object; that is, a reference to an object of a different type\nwhich is contained within a delegated admin scope.", "additionalProperties": false, "required": [ "ObjectType", "Object" ], "properties": { "ObjectType": { "description": "Type of the scoped object.", "$ref": "#/components/schemas/ScopedObjectType" }, "Object": { "title": "String", "type": "string", "description": "Name or Id of the scoped object.", "minLength": 1 } } }, "ScopedObjectResponseModel": { "title": "ScopedObjectResponseModel", "type": "object", "description": "A scoped object; that is, a reference to an object of a different type which is contained within a delegated\nadmin scope.", "additionalProperties": false, "required": [ "Object", "ObjectType" ], "properties": { "Object": { "description": "Reference to the object. To determine the type of the object, and how to dereference it, see\nObjectType.", "$ref": "#/components/schemas/RefResponseModel" }, "ObjectDescription": { "title": "String", "type": "string", "description": "Description of the scoped object, if it has one.", "nullable": true }, "ObjectType": { "description": "Type of the scoped object.", "$ref": "#/components/schemas/ScopedObjectType" } } }, "ScopedObjectResponseModelCollection": { "title": "ScopedObjectResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfScopedObjectResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "ScopedObjectType": { "title": "ScopedObjectType", "type": "string", "description": "Type of an object within a delegated admin scope.", "x-enumNames": [ "Unknown", "HypervisorConnection", "MachineCatalog", "DeliveryGroup", "ApplicationGroup", "Tag", "PolicySet", "ServiceAccount", "ImageDefinition", "Zone" ], "enum": [ "Unknown", "HypervisorConnection", "MachineCatalog", "DeliveryGroup", "ApplicationGroup", "Tag", "PolicySet", "ServiceAccount", "ImageDefinition", "Zone" ] }, "ScopeReferenceModel": { "title": "ScopeReferenceModel", "type": "object", "description": "ScopeReferenceModel class.", "additionalProperties": false, "properties": { "ScopeId": { "title": "Guid", "type": "string", "description": "Scope unique Id.", "format": "guid" }, "ScopeName": { "title": "String", "type": "string", "description": "Scope name.", "nullable": true } } }, "ScopeResponseModel": { "title": "ScopeResponseModel", "type": "object", "description": "Response object representing an administrative scope.", "additionalProperties": false, "required": [ "Id", "Name", "IsBuiltIn", "IsAllScope", "IsTenantScope" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the administrative scope.\nUsed to be: ScopeId (and it was not globally unique)\nNeeds to be globally unique\nMight be constructed from site ID + internal Uid", "minLength": 1 }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED. Use .` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED. Use .", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the administrative scope.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of the administrative scope.", "nullable": true }, "IsBuiltIn": { "title": "Boolean", "type": "boolean", "description": "Whether the administrative scope is built-in." }, "IsAllScope": { "title": "Boolean", "type": "boolean", "description": "Indicates the built-in \"All\" scope. There will be\nexactly one scope with this property set to `true`." }, "IsTenantScope": { "title": "Boolean", "type": "boolean", "description": "Whether the scope is created for CSP tenant." }, "TenantId": { "title": "String", "type": "string", "description": "Id of the CSP tenant. Valid when IsTenantScope is true.", "nullable": true }, "TenantName": { "title": "String", "type": "string", "description": "Name of the CSP tenant. Valid when IsTenantScope is true.", "nullable": true } } }, "ScopeResponseModelCollection": { "title": "ScopeResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfScopeResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "SdkGpoPolicySetType": { "title": "SdkGpoPolicySetType", "type": "string", "description": "", "x-enumNames": [ "SitePolicies", "DeliveryGroupPolicies", "SiteTemplates", "CustomTemplates" ], "enum": [ "SitePolicies", "DeliveryGroupPolicies", "SiteTemplates", "CustomTemplates" ] }, "SearchDateOption": { "title": "Nullable`1", "type": "string", "description": "Search date and time options.", "x-enumNames": [ "LastMinute", "Last5Minutes", "Last30Minutes", "LastHour", "Last12Hours", "Last24Hours", "Today", "Yesterday", "Last7Days", "Last28Days", "LastMonth", "LastThreeMonths", "LastSixMonths" ], "enum": [ "LastMinute", "Last5Minutes", "Last30Minutes", "LastHour", "Last12Hours", "Last24Hours", "Today", "Yesterday", "Last7Days", "Last28Days", "LastMonth", "LastThreeMonths", "LastSixMonths" ] }, "SearchFilter": { "title": "SearchFilter", "type": "object", "description": "Search filter for policy sets.", "additionalProperties": false, "required": [ "Property", "Value", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/SearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match. For boolean properties this must be `\"true\"` or `\"false\"`. For string properties and enum\nvalues, this is case insensitive.", "minLength": 1 }, "Operator": { "description": "The comparison operator to use when determining if an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "SearchFilter2": { "title": "SearchFilter", "type": "object", "description": "Search filter for policies.", "additionalProperties": false, "required": [ "Property", "Value", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/PolicyProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match. For boolean properties this must be `\"true\"` or `\"false\"`. For string properties and enum\nvalues, this is case insensitive.", "minLength": 1 }, "Operator": { "description": "The comparison operator to use when determining if an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "SearchFilter3": { "title": "SearchFilter", "type": "object", "description": "Search filter for settings.", "additionalProperties": false, "required": [ "Property", "Value", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/SettingProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match. For boolean properties this must be `\"true\"` or `\"false\"`. For string properties and enum\nvalues, this is case insensitive.", "minLength": 1 }, "Operator": { "description": "The comparison operator to use when determining if an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "SearchFilter4": { "title": "SearchFilter", "type": "object", "description": "Search filter for filters.", "additionalProperties": false, "required": [ "Property", "Value", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/FilterProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match. For boolean properties this must be `\"true\"` or `\"false\"`. For string properties and enum\nvalues, this is case insensitive.", "minLength": 1 }, "Operator": { "description": "The comparison operator to use when determining if an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "SearchFilterGroupType": { "title": "SearchFilterGroupType", "type": "string", "description": "Type of how filter criteria are grouped.", "x-enumNames": [ "Or", "And" ], "enum": [ "Or", "And" ] }, "SearchOperator": { "title": "SearchOperator", "type": "string", "description": "Search operators.", "x-enumNames": [ "Equals", "NotEquals", "LessThan", "GreaterThan", "LessThanOrEquals", "GreaterThanOrEquals", "Like", "NotLike", "EndsWith", "NotEndsWith", "StartsWith", "NotStartsWith", "Any", "None", "Contains", "NotContains", "ContainsLike", "NotContainsLike", "ContainsEndsWith", "NotContainsEndsWith", "ContainsStartsWith", "NotContainsStartsWith", "In", "NotIn", "IsWithin", "IsNotWithin" ], "enum": [ "Equals", "NotEquals", "LessThan", "GreaterThan", "LessThanOrEquals", "GreaterThanOrEquals", "Like", "NotLike", "EndsWith", "NotEndsWith", "StartsWith", "NotStartsWith", "Any", "None", "Contains", "NotContains", "ContainsLike", "NotContainsLike", "ContainsEndsWith", "NotContainsEndsWith", "ContainsStartsWith", "NotContainsStartsWith", "In", "NotIn", "IsWithin", "IsNotWithin" ] }, "SearchProperty": { "title": "SearchProperty", "type": "string", "description": "Names of policy set properties that can be specified in a search.", "x-enumNames": [ "Description", "IsAssigned", "Name", "PolicyCount", "PolicySetType" ], "enum": [ "Description", "IsAssigned", "Name", "PolicyCount", "PolicySetType" ] }, "SearchStartMenuApplicationsRequestModel": { "title": "SearchStartMenuApplicationsRequestModel", "type": "object", "description": "Search Start Menu Applications Request Model.", "additionalProperties": false, "properties": { "ApplicationGroups": { "title": "String[]", "type": "array", "description": "The Application Groups which the start menu applications will be browsed from.", "nullable": true, "example": [ "Name of an application group" ], "items": { "title": "String", "type": "string" } }, "DeliveryGroups": { "title": "String[]", "type": "array", "description": "The Delivery Groups which the start menu applications will be browsed from", "nullable": true, "example": [ "Name of a delivery group" ], "items": { "title": "String", "type": "string" } }, "TagRestrictions": { "title": "String[]", "type": "array", "description": "The Tag Restrictions, which means only machines with these tags can be used to browse start menu applications.", "nullable": true, "example": [ "Name of a tag" ], "items": { "title": "String", "type": "string" } } } }, "SecurityGroup": { "title": "SecurityGroup", "type": "object", "description": "Data contract for SecurityGroupModel.", "additionalProperties": false, "required": [ "Description", "EgressRules", "IngressRules", "VirtualPrivateCloudId" ], "properties": { "Description": { "title": "String", "type": "string", "description": "Gets or sets the Description.", "minLength": 1 }, "EgressRules": { "title": "IList`1", "type": "array", "description": "Gets the EgressRules.", "items": { "$ref": "#/components/schemas/SecurityGroupRule" } }, "IngressRules": { "title": "IList`1", "type": "array", "description": "Gets the IngressRules.", "items": { "$ref": "#/components/schemas/SecurityGroupRule" } }, "VirtualPrivateCloudId": { "title": "String", "type": "string", "description": "Gets or sets the VirtualPrivateCloudId.", "minLength": 1 } } }, "SecurityGroupRule": { "title": "SecurityGroupRule", "type": "object", "description": "Data contract for SecurityGroupRuleModel.", "additionalProperties": false, "required": [ "FromPort", "SecurityGroupIds", "IPRanges", "Protocol", "ToPort" ], "properties": { "FromPort": { "title": "Int32", "type": "integer", "description": "Gets or sets the FromPort.", "format": "int32" }, "SecurityGroupIds": { "title": "IList`1", "type": "array", "description": "Gets the SecurityGroupIds.", "items": { "title": "String", "type": "string" } }, "IPRanges": { "title": "IList`1", "type": "array", "description": "Gets the IPRanges.", "items": { "title": "String", "type": "string" } }, "Protocol": { "title": "String", "type": "string", "description": "Gets or sets the Protocol.", "minLength": 1 }, "ToPort": { "title": "Int32", "type": "integer", "description": "Gets or sets the ToPort.", "format": "int32" } } }, "SecurityKeyConfigurationRequestModel": { "title": "SecurityKeyConfigurationRequestModel", "type": "object", "description": "Request object for modification of the site security key configuration.", "additionalProperties": false, "properties": { "Key1": { "title": "String", "type": "string", "description": "The first security key.", "nullable": true }, "Key2": { "title": "String", "type": "string", "description": "The second security key.", "nullable": true }, "RequireKeyForSta": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to require a key to authenticate communications over the STA port.", "nullable": true }, "RequireKeyForXml": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to require a key to authenticate communications over the XML port.", "nullable": true } } }, "SecurityKeyConfigurationResponseModel": { "title": "SecurityKeyConfigurationResponseModel", "type": "object", "description": "Response object for the site security key configuration.", "additionalProperties": false, "required": [ "Key1", "Key2", "RequireKeyForSta", "RequireKeyForXml" ], "properties": { "Key1": { "title": "String", "type": "string", "description": "The first security key.", "minLength": 1 }, "Key2": { "title": "String", "type": "string", "description": "The second security key.", "minLength": 1 }, "RequireKeyForSta": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to require a key to authenticate communications over the STA port." }, "RequireKeyForXml": { "title": "Boolean", "type": "boolean", "description": "Indicates whether to require a key to authenticate communications over the XML port." } } }, "SelectAllActionType": { "title": "SelectAllActionType", "type": "string", "description": "Represents the types of actions that can be applied to all selected items in a given context.", "x-enumNames": [ "SessionLogOff", "SessionSendMessage", "SessionDisconnect", "MachineSessionLogOff", "MachinePowerManagementAction", "UpdateMachine" ], "enum": [ "SessionLogOff", "SessionSendMessage", "SessionDisconnect", "MachineSessionLogOff", "MachinePowerManagementAction", "UpdateMachine" ] }, "SelectAllRequestModel": { "title": "SelectAllRequestModel", "type": "object", "description": "Represents a request model for selecting all actions.", "additionalProperties": false, "properties": { "SearchRequest": { "title": "String", "type": "string", "description": "Gets or sets the search request for select all action.", "nullable": true }, "Payload": { "title": "String", "type": "string", "description": "Gets or sets the payload", "nullable": true }, "Metadata": { "title": "BaseNameValueStringPairModel[]", "type": "array", "description": "Optional. Set the metadata of the batched action.", "nullable": true, "items": { "$ref": "#/components/schemas/BaseNameValueStringPairModel" } }, "ActionType": { "description": "Gets or sets the type of action to be performed for the select all operation.", "nullable": true, "$ref": "#/components/schemas/SelectAllActionType" } } }, "SelectAllResponseItemModel": { "title": "SelectAllResponseItemModel", "type": "object", "description": "Represents a response model for selecting all actions.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "nullable": true }, "Body": { "title": "String", "type": "string", "description": "Response body, if one was present.", "nullable": true }, "IsSuccessful": { "title": "Boolean", "type": "boolean", "description": "If this action is successfully executed\n " }, "ActionType": { "description": "Gets or sets the type of action to be performed for the select all operation.", "$ref": "#/components/schemas/SelectAllActionType" } } }, "SelectAllResponseModel": { "title": "SelectAllResponseModel", "type": "object", "description": "The response collection of the select all items", "additionalProperties": false, "properties": { "Items": { "title": "SelectAllResponseItemModel[]", "type": "array", "description": "List of select all item responses.", "nullable": true, "items": { "$ref": "#/components/schemas/SelectAllResponseItemModel" } }, "Metadata": { "title": "BaseNameValueStringPairModel[]", "type": "array", "description": "The metadata of the batched action.", "nullable": true, "items": { "$ref": "#/components/schemas/BaseNameValueStringPairModel" } } } }, "SendMessageRequestModel": { "title": "SendMessageRequestModel", "type": "object", "description": "Request to send a message to a session.", "additionalProperties": false, "properties": { "Style": { "description": "The style of message box to use.", "$ref": "#/components/schemas/MessageStyle" }, "Title": { "title": "String", "type": "string", "description": "Text to display in the message box title bar.", "nullable": true, "example": "Title" }, "Text": { "title": "String", "type": "string", "description": "The message to display.", "nullable": true, "example": "Text" } } }, "ServiceAccountCapabilityReference": { "title": "ServiceAccountCapabilityReference", "type": "object", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Gets or sets the name of the capability.", "nullable": true }, "EffectiveScope": { "title": "String", "type": "string", "description": "Gets or sets the effective scope of the capability.", "nullable": true }, "IsHealthy": { "title": "Boolean", "type": "boolean", "description": "Gets or sets the healthy status of the capability." }, "FailureReason": { "title": "String", "type": "string", "description": "Gets or sets the failure reason of the capability.", "nullable": true } } }, "ServiceAccountCriticalIssueType": { "title": "ServiceAccountCriticalIssueType", "type": "string", "description": "The service account critical issue type", "x-enumNames": [ "Unknown", "Unhealthy", "SecretExpired", "BulkPrimaryRefreshTokenExpired" ], "enum": [ "Unknown", "Unhealthy", "SecretExpired", "BulkPrimaryRefreshTokenExpired" ] }, "ServiceAccountNonCriticalIssueType": { "title": "ServiceAccountNonCriticalIssueType", "type": "string", "description": "The service account non critical issue type", "x-enumNames": [ "Unknown", "SecretExpiring", "BulkPrimaryRefreshTokenExpiring" ], "enum": [ "Unknown", "SecretExpiring", "BulkPrimaryRefreshTokenExpiring" ] }, "ServiceAccountResponseModel": { "title": "ServiceAccountResponseModel", "type": "object", "description": "Response model for service account.", "additionalProperties": false, "properties": { "ServiceAccountUid": { "title": "Guid", "type": "string", "format": "guid" }, "IdentityProviderType": { "title": "String", "type": "string", "description": "The identity provider type for the service account", "nullable": true }, "IdentityProviderIdentifier": { "title": "String", "type": "string", "description": "The identity provider id for the service account", "nullable": true }, "AccountId": { "title": "String", "type": "string", "description": "The identifier for the service account", "nullable": true }, "SecretExpiryTime": { "title": "String", "type": "string", "description": "The secret expiration time for the service account", "nullable": true }, "Capabilities": { "title": "ServiceAccountCapabilityReference[]", "type": "array", "description": "The capabilities for the service account", "nullable": true, "items": { "$ref": "#/components/schemas/ServiceAccountCapabilityReference" } }, "IsHealthy": { "title": "Boolean", "type": "boolean", "description": "The healthy status for the service account" }, "FailureReason": { "title": "String", "type": "string", "description": "The failure reason for the service account if IsHealthy is false", "nullable": true }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "The array of administration scopes", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "TenantId": { "title": "Guid", "type": "string", "description": "The tenant id", "format": "guid", "nullable": true }, "DisplayName": { "title": "String", "type": "string", "description": "The display name", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The description", "nullable": true }, "UserPrincipalName": { "title": "String", "type": "string", "description": "The Microsoft Entra ID user principal name.", "nullable": true }, "UserSecretExpiryTime": { "title": "String", "type": "string", "description": "The Microsoft Entra ID user secret expiration time for the service account.", "nullable": true }, "CustomProperties": { "title": "String", "type": "string", "description": "Gets or sets CustomProperties\nFormat is the following: \"CustomProperties\":\"[{\\\"Name\\\":\\\"ProxyHypervisorTrafficThroughConnector\\\",\\\"Value\\\":\\\"true\\\"},{\\\"Name\\\":\\\"ZoneUid\\\",\\\"Value\\\":\\\"4e1d7040-d830-4d97-8f94-342c03846f19\\\"}]\".", "nullable": true }, "BulkEnrollmentPackageName": { "title": "String", "type": "string", "description": "Get or sets Bulk enrollment package name", "nullable": true }, "BulkTokenExpiryTime": { "title": "String", "type": "string", "description": "Bulk token expiry time", "nullable": true }, "CriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "Critical issues", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfServiceAccountCriticalIssueType" } }, "NonCriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "Non-critical issues", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfServiceAccountNonCriticalIssueType" } } } }, "ServiceAccountResponseModelCollection": { "title": "ServiceAccountResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfServiceAccountResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "ServiceAccountTestResponseModel": { "title": "ServiceAccountTestResponseModel", "type": "object", "description": "Response object for a service account test result.", "additionalProperties": false, "properties": { "ServiceAccount": { "description": "The hypervisor upon which the test was run.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "NumPassed": { "title": "Int32", "type": "integer", "description": "The number of tests that passed.", "format": "int32" }, "NumWarnings": { "title": "Int32", "type": "integer", "description": "The number of warnings that were found.", "format": "int32" }, "NumFailures": { "title": "Int32", "type": "integer", "description": "The number of tests that failed.", "format": "int32" }, "TestReport": { "description": "The detailed test report, only included when specifically requested in the API call.", "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } }, "ServiceStatus": { "title": "ServiceStatus", "type": "string", "description": "A status code to indicate the health of the service and database combined", "x-enumNames": [ "Stopped", "DBUnConfigured", "DBRejectedConnection", "InvalidDBConfigured", "DBNotFound", "DBMissingOptionalFeature", "DBMissingMandatoryFeature", "DBNewerVersionThanService", "DBOlderVersionThanService", "DBVersionChangeInProgress", "OK", "PendingFailure", "Failed", "Unknown", "ServiceNotInSiteDB", "InvalidDBConnectionString", "PendingServiceDiscovery", "PendingServiceRegistration", "PendingConfiguration" ], "enum": [ "Stopped", "DBUnConfigured", "DBRejectedConnection", "InvalidDBConfigured", "DBNotFound", "DBMissingOptionalFeature", "DBMissingMandatoryFeature", "DBNewerVersionThanService", "DBOlderVersionThanService", "DBVersionChangeInProgress", "OK", "PendingFailure", "Failed", "Unknown", "ServiceNotInSiteDB", "InvalidDBConnectionString", "PendingServiceDiscovery", "PendingServiceRegistration", "PendingConfiguration" ] }, "SessionBrokeringResponseModel": { "title": "SessionBrokeringResponseModel", "type": "object", "description": "Response object for details about how a session was brokered.", "additionalProperties": false, "required": [ "AutonomouslyBrokered" ], "properties": { "AutonomouslyBrokered": { "title": "Boolean", "type": "boolean", "description": "Indicates whether this is an HDX session established by direct connection\nwithout being brokered." }, "DurationMilliseconds": { "title": "Int32", "type": "integer", "description": "Time taken to broker the session.", "format": "int32", "nullable": true }, "Time": { "title": "String", "type": "string", "description": "Time at which the session was brokered.", "nullable": true }, "FormattedTime": { "title": "String", "type": "string", "description": "Formatted time at which the session was brokered.\nRFC 3339 compatible format.", "nullable": true }, "UserName": { "title": "String", "type": "string", "description": "The user name of the brokering user.", "nullable": true }, "UserSid": { "title": "String", "type": "string", "description": "The SID of the brokering user.", "nullable": true } } }, "SessionChangeHostingAction": { "title": "SessionChangeHostingAction", "type": "string", "description": "Hosting actions which may be taken when a session\nchange occurs on a machine.", "x-enumNames": [ "Unknown", "Nothing", "Suspend", "Shutdown" ], "enum": [ "Unknown", "Nothing", "Suspend", "Shutdown" ] }, "SessionClientResponseModel": { "title": "SessionClientResponseModel", "type": "object", "description": "Response object for details about the client connected to a session.", "additionalProperties": false, "properties": { "DeviceId": { "title": "String", "type": "string", "description": "Unique identifier for the client device that has most recently been associated with the session.", "nullable": true }, "HardwareId": { "title": "String", "type": "string", "description": "Unique identifier for the client hardware that has been most recently associated with the session.", "nullable": true }, "IPAddress": { "title": "String", "type": "string", "description": "The IP address of the client connected to the session.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "The host name of the client connected to the session.", "nullable": true }, "Platform": { "title": "String", "type": "string", "description": "The name of client platform, as indicated by client product ID.", "nullable": true }, "ProductId": { "title": "Int32", "type": "integer", "description": "The product ID of the client connected to the session.", "format": "int32", "nullable": true }, "ReceiverIPAddress": { "title": "String", "type": "string", "description": "The IP address of the client as supplied by Receiver (for example,\nReceiver for Web) when the session was launched, or reconnected.", "nullable": true }, "ReceiverName": { "title": "String", "type": "string", "description": "The name of the client as supplied by Receiver (for example,\nReceiver for Web) when the session was launched, or reconnected.", "nullable": true }, "Version": { "title": "String", "type": "string", "description": "The version of the Citrix Receiver running on the client connected to the session.", "nullable": true } } }, "SessionConnectionResponseModel": { "title": "SessionConnectionResponseModel", "type": "object", "description": "Response model for details about the connection from the client to the session.", "additionalProperties": false, "properties": { "ConnectedViaHostName": { "title": "String", "type": "string", "description": "The host name of the incoming connection. This is usually a gateway, router or client.", "nullable": true }, "ConnectedViaIP": { "title": "String", "type": "string", "description": "The IP address of the incoming connection This is usually a gateway, router or client.", "nullable": true }, "ConnectionMode": { "description": "The way in which the most recent connection to the session was established.", "nullable": true, "$ref": "#/components/schemas/ConnectionMode" }, "LaunchedViaHostName": { "title": "String", "type": "string", "description": "The host name of the StoreFront server used to launch the session.", "nullable": true }, "LaunchedViaIP": { "title": "String", "type": "string", "description": "The IP address of the StoreFront server used to launch the session.", "nullable": true }, "Protocol": { "description": "The protocol that the session is using.", "nullable": true, "$ref": "#/components/schemas/ProtocolType" }, "SecureIcaActive": { "title": "Boolean", "type": "boolean", "description": "Indicates whether SecureICA is active on the session.", "nullable": true }, "SmartAccessTags": { "title": "SmartAccessTagResponseModel[]", "type": "array", "description": "The Smart Access tags for this session.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagResponseModel" } }, "LaunchedViaPublishedName": { "title": "String", "type": "string", "description": "The published name of the StoreFront server used to launch the session.", "nullable": true } } }, "SessionReconnection": { "title": "SessionReconnection", "type": "string", "description": "Session reconnection modes.", "x-enumNames": [ "Unknown", "Always", "DisconnectedOnly", "SameEndpointOnly" ], "enum": [ "Unknown", "Always", "DisconnectedOnly", "SameEndpointOnly" ] }, "SessionRecordingStatusResponseModel": { "title": "SessionRecordingStatusResponseModel", "type": "object", "description": "Session Recording Status model of current Orchestration instance.\n ", "additionalProperties": false, "properties": { "IsSessionBeingRecorded": { "title": "Boolean", "type": "boolean", "description": "Indicates if current session is being recorded." } } }, "SessionResponseModel": { "title": "SessionResponseModel", "type": "object", "description": "Default response field (Only return the fields specified there if supported in API ): Id,Uid,AppState,AppStateLastChangeTime,FormattedAppStateLastChangeTime,Client,EstablishmentDurationMilliseconds,EstablishmentTime,FormattedEstablishmentTime,IsAnonymousUser,IsHidden,LogoffInProgress,LogonInProgress,SessionType,StartTime,FormattedStartTime,State,StateChangeTime,FormattedStateChangeTime,UntrustedUserName,User. \n Response object for a session.\n ", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Id of the session.", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "`Deprecated, use Id.` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "Deprecated, use Id.", "nullable": true }, "ApplicationsInUse": { "title": "RefResponseModel[]", "type": "array", "description": "List of applications in use in the session.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "AppState": { "description": "The app state of the session.", "$ref": "#/components/schemas/AppState" }, "AppStateLastChangeTime": { "title": "String", "type": "string", "description": "The time when the session entered the current app state.", "nullable": true }, "FormattedAppStateLastChangeTime": { "title": "String", "type": "string", "description": "The formatted time when the session entered the current app state.\nRFC 3339 compatible format.", "nullable": true }, "Brokering": { "description": "Details about how the session was brokered.", "nullable": true, "$ref": "#/components/schemas/SessionBrokeringResponseModel" }, "Client": { "description": "Details about the client connected to the session.", "nullable": true, "$ref": "#/components/schemas/SessionClientResponseModel" }, "Connection": { "description": "Details about the connection from the client to the session.", "nullable": true, "$ref": "#/components/schemas/SessionConnectionResponseModel" }, "ContainerScopes": { "title": "ContainerScopeResponseModel[]", "type": "array", "description": "Delegated admin scopes in which the containers of the\nsession reside.", "nullable": true, "items": { "$ref": "#/components/schemas/ContainerScopeResponseModel" } }, "EstablishmentDurationMilliseconds": { "title": "Int32", "type": "integer", "description": "Duration that it took to establish the session.", "format": "int32", "nullable": true }, "EstablishmentTime": { "title": "String", "type": "string", "description": "Time at which the session was established.", "nullable": true }, "FormattedEstablishmentTime": { "title": "String", "type": "string", "description": "Formatted time at which the session was established.\nRFC 3339 compatible format.", "nullable": true }, "IsAnonymousUser": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the session was established anonymously\n(without user credentials), in this case a temporary local\nuser account on the machine is used." }, "IsHidden": { "title": "Boolean", "type": "boolean", "description": "Flag to indicate if the session is currently hidden from the user and not to be reconnected to." }, "LogoffInProgress": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the session is in the process of being logged off." }, "LogonInProgress": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the session is still executing user logon processing or not." }, "Machine": { "description": "The machine on which the session is hosted.", "nullable": true, "$ref": "#/components/schemas/MachineResponseModel" }, "SessionType": { "description": "Indicates if this is an Application or Desktop session.", "$ref": "#/components/schemas/SessionType" }, "StartTime": { "title": "String", "type": "string", "description": "The time indicates when the session was started.", "nullable": true }, "FormattedStartTime": { "title": "String", "type": "string", "description": "The formatted time indicates when the session was started.\nRFC 3339 compatible format.", "nullable": true }, "State": { "description": "The state of the session.", "$ref": "#/components/schemas/SessionState" }, "StateChangeTime": { "title": "String", "type": "string", "description": "The time of the most recent state change for the session.", "nullable": true }, "FormattedStateChangeTime": { "title": "String", "type": "string", "description": "The formatted time of the most recent state change for the session.\nRFC 3339 compatible format.", "nullable": true }, "UntrustedUserName": { "title": "String", "type": "string", "description": "The name of the logged-on user reported directly from the machine (in\nthe form DOMAIN\\user). This may be useful where the user is logged in\nto a non-domain account, however the name cannot be verified and must\ntherefore be considered untrusted.", "nullable": true }, "User": { "description": "The session user.", "nullable": true, "$ref": "#/components/schemas/IdentityUserResponseModel" } } }, "SessionResponseModelCollection": { "title": "SessionResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfSessionResponseModel" }, { "type": "object", "description": "Application group response model collection", "additionalProperties": false } ] }, "SessionState": { "title": "SessionState", "type": "string", "description": "Session states.", "x-enumNames": [ "Unknown", "Connected", "Active", "Disconnected" ], "enum": [ "Unknown", "Connected", "Active", "Disconnected" ] }, "SessionsTrendResponseModel": { "title": "SessionsTrendResponseModel", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfSessionTrendItem" }, { "type": "object", "additionalProperties": false } ] }, "SessionSupport": { "title": "SessionSupport", "type": "string", "description": "Quantity of sessions supported per-machine.", "x-enumNames": [ "Unknown", "SingleSession", "MultiSession" ], "enum": [ "Unknown", "SingleSession", "MultiSession" ] }, "SessionTrendItem": { "title": "SessionTrendItem", "type": "object", "additionalProperties": false, "properties": { "Date": { "title": "String", "type": "string", "description": "The date and time for this SessionTrendItem.", "nullable": true }, "ConcurrentSessions": { "title": "Int32", "type": "integer", "description": "ActiveSessions", "format": "int32", "nullable": true }, "ConnectedSessions": { "title": "Int32", "type": "integer", "description": "ConnectedSessions", "format": "int32", "nullable": true }, "DisconnectedSessions": { "title": "Int32", "type": "integer", "description": "DisconnectedSessions", "format": "int32", "nullable": true } } }, "SessionType": { "title": "SessionType", "type": "string", "description": "Types of sessions.", "x-enumNames": [ "Unknown", "Desktop", "Application" ], "enum": [ "Unknown", "Desktop", "Application" ] }, "SetPreferenceModel": { "title": "SetPreferenceModel", "type": "object", "description": "Set a user preference.", "additionalProperties": false, "required": [ "Name", "Value" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name.", "maxLength": 1024, "minLength": 1, "pattern": "(.*)*", "example": "Name of a preference" }, "Value": { "title": "String", "type": "string", "description": "Value.", "maxLength": 1000000, "minLength": 1, "pattern": "^[\\w\\s\\[\\]\\(\\)\\{\\}:;<>,./?\"'!@#$%^&*+=|\\-\\\\~`]*$", "example": "Value of a preference" } } }, "SetRecommendationRequestModel": { "title": "SetRecommendationRequestModel", "type": "object", "additionalProperties": false, "properties": { "State": { "description": "The state of the recommendations - Dismiss", "nullable": true, "$ref": "#/components/schemas/RecommendationState" }, "Reason": { "title": "String", "type": "string", "description": "The reason why you want to dismiss the recommendation.", "nullable": true } } }, "SetRecommendationsRequestModel": { "title": "SetRecommendationsRequestModel", "allOf": [ { "$ref": "#/components/schemas/SetRecommendationRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "Ids": { "title": "String[]", "type": "array", "description": "The list of the recommendation id. The format should be GUID array.", "nullable": true, "items": { "title": "String", "type": "string" } } } } ] }, "SettingDefinition": { "title": "SettingDefinition", "type": "object", "description": "Setting definition.", "additionalProperties": false, "properties": { "settingName": { "title": "String", "type": "string", "description": "Setting name. This is globally unique.", "nullable": true }, "editorName": { "title": "String", "type": "string", "description": "The setting editor name.", "nullable": true }, "displayName": { "title": "String", "type": "string", "description": "Translated setting name. Is globally unique.", "nullable": true }, "category": { "title": "String", "type": "string", "description": "Setting category, e.g., ICA\\Printing.", "nullable": true }, "explanation": { "title": "String", "type": "string", "description": "Setting detailed description.", "nullable": true }, "isUserSetting": { "title": "Boolean", "type": "boolean", "description": "true = user, false = machine." }, "valueType": { "title": "String", "type": "string", "description": "Type of setting value.", "nullable": true }, "isEnableDisable": { "title": "Boolean", "type": "boolean", "description": "Label test for a boolean setting, display enable/disable if true, otherwise allow/prohibit." }, "isToggled": { "title": "Boolean", "type": "boolean", "description": "Indicate if the integer, string, enum or multiline string is toggled." }, "hideValueHint": { "title": "Boolean", "type": "boolean", "description": "Indicate if the validation message for the value should be shown." }, "valueAsArray": { "title": "Boolean", "type": "boolean", "description": "For a string setting, if this is true, it indicates the value should be treated as a JSON array of strings." }, "defaultValue": { "title": "String", "type": "string", "description": "Setting default value.", "nullable": true }, "secureDefaultValue": { "title": "String", "type": "string", "description": "Setting secure default value", "nullable": true }, "defaultSnip": { "title": "String", "type": "string", "description": "An abbreviated shortened version of the default value.", "nullable": true }, "disabledValue": { "title": "String", "type": "string", "description": "Disabled value for toggled settings.", "nullable": true }, "initialValue": { "title": "String", "type": "string", "description": "Initial value for toggled settings when value is not disabled.", "nullable": true }, "valueMinimum": { "title": "String", "type": "string", "description": "Minimal value for integer setting.", "nullable": true }, "valueMaximum": { "title": "String", "type": "string", "description": "Maximal value for integer setting.", "nullable": true }, "valueValidator": { "title": "String", "type": "string", "description": "An expression executed to validate the value.", "nullable": true }, "validatorError": { "title": "String", "type": "string", "description": "Warning message issued when validator fails (throws exception).", "nullable": true }, "relatedSettings": { "title": "Dictionary`2", "type": "object", "description": "Related settings.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "dependsOn": { "title": "String", "type": "string", "description": "The setting that must be enabled for this setting to work.", "nullable": true }, "valueUnit": { "title": "String", "type": "string", "description": "Unit of value in translated text.", "nullable": true }, "allowedText": { "title": "String", "type": "string", "description": "Custom text for the allowed explanation for some boolean settings.", "nullable": true }, "deniedText": { "title": "String", "type": "string", "description": "Custom text for the denied explanation for some boolean settings.", "nullable": true }, "enumType": { "description": "Enum type information if this setting is an enum.", "nullable": true, "$ref": "#/components/schemas/EnumerationType" }, "versionDetails": { "title": "VersionDetail[]", "type": "array", "description": "VDA versions honoring this setting.", "nullable": true, "items": { "$ref": "#/components/schemas/VersionDetail" } }, "versionCode": { "title": "String", "type": "string", "description": "The version string in GPFX file, e.g., XD=7.8,*,B.", "nullable": true }, "vdaVersions": { "title": "String[]", "type": "array", "description": "Array of VDA versions, e.g., 7.8S, 7.8M. This is much lighter than VersionDetails.", "nullable": true, "items": { "title": "String", "type": "string" } }, "gpoScope": { "title": "String", "type": "string", "description": "Scope, e.g. ConfigSlot.", "nullable": true }, "productGroup": { "title": "String", "type": "string", "description": "Group, e.g., UPM.", "nullable": true } } }, "SettingDefinitionContract": { "title": "SettingDefinitionContract", "type": "object", "description": "Setting definition contract. This class should be read-only.", "additionalProperties": false, "properties": { "EditorName": { "title": "String", "type": "string", "description": "The setting editor name.", "nullable": true }, "SettingName": { "title": "String", "type": "string", "description": "Setting name; Is globally unique", "nullable": true }, "SettingType": { "title": "String", "type": "string", "description": "The setting type as defined by its value.", "nullable": true }, "DisplayName": { "title": "String", "type": "string", "description": "Translated setting name. Is globally unique.", "nullable": true }, "Category": { "title": "String", "type": "string", "description": "Setting category, e.g., ICA\\Printing.", "nullable": true }, "Explanation": { "title": "String", "type": "string", "description": "Setting detailed description", "nullable": true }, "IsUserSetting": { "title": "Boolean", "type": "boolean", "description": "true = user, false = machine" }, "ValueType": { "title": "String", "type": "string", "description": "Type of setting value", "nullable": true }, "IsEnableDisable": { "title": "Boolean", "type": "boolean", "description": "Label test for a boolean setting, display enable/disable if true, otherwise allow/prohibit" }, "IsToggled": { "title": "Boolean", "type": "boolean", "description": "Indicate if the setting is toggled." }, "HideValueHint": { "title": "Boolean", "type": "boolean", "description": "Indicate if the detailed validation message about the value should be shown." }, "DefaultValue": { "title": "String", "type": "string", "description": "Setting default value", "nullable": true }, "DisabledValue": { "title": "String", "type": "string", "description": "Disabled value for toggled settings", "nullable": true }, "InitialValue": { "title": "String", "type": "string", "description": "Initial value for toggled settings when value is not disabled.", "nullable": true }, "ValueMinimum": { "title": "String", "type": "string", "description": "Minimal value for integer setting", "nullable": true }, "ValueMaximum": { "title": "String", "type": "string", "description": "Maximal value for integer setting", "nullable": true }, "ValueValidator": { "title": "String", "type": "string", "description": "An expression executed to validate the value", "nullable": true }, "ValidatorError": { "title": "String", "type": "string", "description": "Warning message issued when validator fails (throws exception)", "nullable": true }, "RelatedSettings": { "title": "Dictionary`2", "type": "object", "description": "Related settings.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "ValueUnit": { "title": "String", "type": "string", "description": "Unit of value in translated text", "nullable": true }, "AllowedText": { "title": "String", "type": "string", "description": "Custom text for the allowed explanation for some boolean settings.", "nullable": true }, "DeniedText": { "title": "String", "type": "string", "description": "Custom text for the denied explanation for some boolean settings.", "nullable": true }, "EnumType": { "description": "Enum type information if this setting is an enum.", "nullable": true, "$ref": "#/components/schemas/EnumerationTypeContract" }, "VdaVersions": { "title": "VdaVersionContract[]", "type": "array", "description": "VDA versions honoring this setting.", "nullable": true, "items": { "$ref": "#/components/schemas/VdaVersionContract" } }, "GpoScope": { "title": "String", "type": "string", "description": "Scope, e.g. ConfigSlot", "nullable": true }, "ProductGroup": { "title": "String", "type": "string", "description": "Group, e.g., UPM.", "nullable": true } } }, "SettingDefinitionEnvelope": { "title": "SettingDefinitionEnvelope", "type": "object", "description": "Top level object for setting definitions. Should support paging. Should support HATEOAS links.", "additionalProperties": false, "properties": { "items": { "title": "SettingDefinition[]", "type": "array", "description": "Items of collection.", "nullable": true, "items": { "$ref": "#/components/schemas/SettingDefinition" } }, "continuationToken": { "title": "String", "type": "string", "description": "Continuation token if paging is requested. This is a compressed JSON string of the SettingSearchFilters\nobject.", "nullable": true } } }, "SettingProperty": { "title": "SettingProperty", "type": "string", "description": "Names of setting properties that can be specified in a search.", "x-enumNames": [ "SettingName", "SettingValue", "UseDefault" ], "enum": [ "SettingName", "SettingValue", "UseDefault" ] }, "SettingRequest": { "title": "SettingRequest", "type": "object", "description": "Setting request.", "additionalProperties": false, "properties": { "settingName": { "title": "String", "type": "string", "description": "Setting type. Is globally unique.", "nullable": true }, "useDefault": { "title": "Boolean", "type": "boolean", "description": "Indicate if the default setting value is used. If the setting data type is bool, this is ignored. For all\nother settings, if this value is true, the setting value is ignored and if this value is false, the setting\nvalue is used." }, "settingValue": { "title": "String", "type": "string", "description": "The setting value.", "nullable": true } } }, "SettingRequestContract": { "title": "SettingRequestContract", "type": "object", "description": "Setting instance contract", "additionalProperties": false, "properties": { "SettingType": { "title": "String", "type": "string", "description": "Setting type. Is globally unique.", "nullable": true }, "SettingValue": { "title": "String", "type": "string", "description": "The setting value.\n* For all setting types, excluding booleans, if null, use the default value.\n* For all setting types, including booleans, otherwise, use the specified value.\n* For boolean types, the value can be \"true\"/\"false\", \"1\"/\"0\", null will be accepted as using default value.", "nullable": true }, "TypedValue": { "title": "Object", "type": "object", "description": "The value in native C# type. If this value is null, use SettingValue, otherwise use this value.", "nullable": true } } }, "SettingResponse": { "title": "SettingResponse", "type": "object", "description": "Setting response.", "additionalProperties": false, "properties": { "policyGuid": { "title": "Guid", "type": "string", "description": "The GUID of the policy that owns this setting.", "format": "guid" }, "settingGuid": { "title": "Guid", "type": "string", "description": "The setting GUID.", "format": "guid" }, "settingName": { "title": "String", "type": "string", "description": "Setting name. Is globally unique.", "nullable": true }, "useDefault": { "title": "Boolean", "type": "boolean", "description": "Indicate if the default setting value is used. If the setting data type is bool, this is ignored. For all\nother settings, if this value is true, the setting value is ignored and if this value is false, the\nsetting value is used." }, "settingValue": { "title": "String", "type": "string", "description": "The current setting value. For boolean types, the returned value is \"True\"/\"False\". The caller should\nassume the value is case-insensitive.", "nullable": true } } }, "SettingResponseContract": { "title": "SettingResponseContract", "type": "object", "description": "Setting instance contract", "additionalProperties": false, "properties": { "SettingName": { "title": "String", "type": "string", "description": "Setting name. Is globally unique.", "nullable": true }, "CurrentValue": { "title": "String", "type": "string", "description": "The current setting value.\n* For boolean types, the returned value is \"True\"/\"False\". The caller should assume the value is\n case-insensitive.\n* For all other types, if the value is null, use default value, otherwise use the specified value.", "nullable": true } } }, "SettingSearch": { "title": "SettingSearch", "type": "object", "description": "Setting search data.", "additionalProperties": false, "properties": { "SearchFilters": { "title": "SearchFilter[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/SearchFilter3" } }, "SortCriteria": { "description": "Sort criteria for the results. If no sort criteria is specified, the results are unsorted.", "nullable": true, "$ref": "#/components/schemas/SortingMethod3" } } }, "SharingKind": { "title": "SharingKind", "type": "string", "description": "How machines are shared.", "x-enumNames": [ "Unknown", "Private", "Shared" ], "enum": [ "Unknown", "Private", "Shared" ] }, "SimplifiedAccessPolicyRequestModel": { "title": "SimplifiedAccessPolicyRequestModel", "type": "object", "description": "Request object for a simplified access policy for delivery groups.", "additionalProperties": false, "properties": { "AllowAnonymous": { "title": "Boolean", "type": "boolean", "description": "Whether to allow anonymous connections to the delivery group.", "nullable": true }, "AllowHdxAccess": { "title": "Boolean", "type": "boolean", "description": "Whether to allow connections using HDX.\nWas: AllowsHdxAccess", "default": true, "nullable": true }, "AllowMachineRestart": { "title": "Boolean", "type": "boolean", "description": "Whether to allow users to self-service restart machines.", "default": true, "nullable": true }, "AllowRdpAccess": { "title": "Boolean", "type": "boolean", "description": "Whether to allow connections using RDP.\nWas: AllowsRdpAccess", "default": true, "nullable": true }, "ConnectNotViaNetScalerGatewayAllowed": { "title": "Boolean", "type": "boolean", "description": "Whether to allow connections that do not come through\nNetScaler Gateway.", "default": true, "nullable": true }, "ConnectViaNetScalerGatewayAllowed": { "title": "Boolean", "type": "boolean", "description": "Whether to allow connections that come through\nNetScaler Gateway.", "default": true, "nullable": true }, "IncludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedSmartAccessTags\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.", "default": true, "nullable": true }, "IncludedSmartAccessTags": { "title": "SmartAccessTagRequestModel[]", "type": "array", "description": "Specifies the SmartAccess tags which grant access to\nthe delivery group, if any occur in those provided by\nNetScaler Gateway with the user's connection.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagRequestModel" } }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the IncludedUsers filter is enabled.\nIf the filter is disabled, it is ignored when the access policy\nis evaluated.", "default": false, "nullable": true }, "IncludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the users and groups who are granted access to\nthe delivery group.", "nullable": true, "example": [ "Name of an included user" ], "items": { "title": "String", "type": "string" } }, "ExcludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the ExcludedUsers filter is enabled.\nIf the filter is disabled, it is ignored when the access policy\nis evaluated.", "default": false, "nullable": true }, "ExcludedUsers": { "title": "String[]", "type": "array", "description": "Specifies the users and groups who are denied access to\nthe delivery group.", "nullable": true, "example": [ "Name of an excluded user" ], "items": { "title": "String", "type": "string" } } } }, "SimplifiedAccessPolicyResponseModel": { "title": "SimplifiedAccessPolicyResponseModel", "type": "object", "description": "The response object indicating the simplified access model for a\ndelivery group.\nThe following two properties used to be just one confusing enum that doesn't match the UI.\nOLD -> NEW\n==========\nAllowedUser.AnyAuthenticated -> IncludedUserFilterEnabled=false + AllowAnonymous=false\nAllowedUser.Filtered -> IncludedUserFilterEnabled=true + AllowAnonymous=false\nAllowedUser.Any -> IncludedUserFilterEnabled=false + AllowAnonymous=true\nAllowedUser.FilteredOrAnonymous -> IncludedUserFilterEnabled=true + AllowAnonymous=true\nAllowedUser.AnonymousOnly -> NOT SUPPORTED by SimplifiedAccessPolicy", "additionalProperties": false, "required": [ "AllowAnonymous", "AllowHdxAccess", "AllowRdpAccess", "ConnectNotViaNetScalerGatewayAllowed", "ConnectViaNetScalerGatewayAllowed", "IncludedSmartAccessFilterEnabled", "IncludedUserFilterEnabled", "ExcludedUserFilterEnabled" ], "properties": { "AllowAnonymous": { "title": "Boolean", "type": "boolean", "description": "Whether anonymous connections are allowed to the delivery group." }, "AllowHdxAccess": { "title": "Boolean", "type": "boolean", "description": "Whether HDX connections are allowed to the delivery group.\nCHANGE: was:\npublic bool AllowsHdxAccess { get; set; }" }, "AllowMachineRestart": { "title": "Boolean", "type": "boolean", "description": "Whether users are allowed to self-service restart machines.", "nullable": true }, "AllowRdpAccess": { "title": "Boolean", "type": "boolean", "description": "Whether RDP connections are allowed to the delivery group.\nCHANGE: was:\npublic bool AllowsRdpAccess { get; set; }" }, "ConnectNotViaNetScalerGatewayAllowed": { "title": "Boolean", "type": "boolean", "description": "Whether connections that do not come through\nNetScaler Gateway are allowed.\nCHANGE: was:\npublic bool ConnectNotViaAccessGatewayAllowed { get; set; }" }, "ConnectViaNetScalerGatewayAllowed": { "title": "Boolean", "type": "boolean", "description": "Whether connections that come through\nNetScaler Gateway are allowed.\nCHANGE: was:\npublic bool ConnectViaAccessGatewayAllowed { get; set; }" }, "IncludedSmartAccessFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedSmartAccessTags\nfilter is enabled. If the filter is disabled, it is ignored\nwhen the access policy is evaluated.\nCHANGE: was:\npublic bool AccessGatewayConnectionsUseFilters { get; set; }" }, "IncludedSmartAccessTags": { "title": "SmartAccessTagResponseModel[]", "type": "array", "description": "The SmartAccess tags which grant access to\nthe delivery group, if any occur in those provided by\nNetScaler Gateway with the user's connection.", "nullable": true, "items": { "$ref": "#/components/schemas/SmartAccessTagResponseModel" } }, "IncludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the IncludedUsers filter is enabled.\nIf the filter is disabled, it is ignored when the access policy\nis evaluated." }, "IncludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The users and groups who are granted access to\nthe delivery group.\nCHANGE: was:\npublic ADAccount[] IncludedUsers { get; set; }", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } }, "ExcludedUserFilterEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the ExcludedUsers filter is enabled.\nIf the filter is disabled, it is ignored when the access policy\nis evaluated." }, "ExcludedUsers": { "title": "IdentityUserResponseModel[]", "type": "array", "description": "The users and groups who are denied access to\nthe delivery group.", "nullable": true, "items": { "$ref": "#/components/schemas/IdentityUserResponseModel" } } } }, "SimulationRequestContract": { "title": "SimulationRequestContract", "type": "object", "description": "Simulation request. This is basically the filter evidence.", "additionalProperties": false, "properties": { "ComputerName": { "title": "String", "type": "string", "description": "Name of the selected computer.", "nullable": true }, "UserSid": { "title": "String", "type": "string", "description": "SID of the selected user.", "nullable": true }, "GroupSids": { "title": "String[]", "type": "array", "description": "SIDs of the groups to which the user belongs.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ClientIpAddress": { "title": "String", "type": "string", "description": "Client IP address.", "nullable": true }, "ClientName": { "title": "String", "type": "string", "description": "Client name.", "nullable": true }, "ClientPlatform": { "title": "String", "type": "string", "description": "Client platform.", "nullable": true }, "DeliveryGroupGuid": { "title": "Guid", "type": "string", "description": "Delivery group GUID.", "format": "guid" }, "DeliveryGroupType": { "title": "String", "type": "string", "description": "Delivery group type, values are members of enum DesktopKind.", "nullable": true }, "ComputerOu": { "title": "String", "type": "string", "description": "The OU the computer is in.", "nullable": true }, "Tags": { "title": "Guid[]", "type": "array", "description": "Tags.", "nullable": true, "items": { "title": "Guid", "type": "string", "format": "guid" } }, "IsUsingAccessGateway": { "title": "Boolean", "type": "boolean", "description": "Using Access Gateway." }, "AccessGatewayFarm": { "title": "String", "type": "string", "description": "Access Gateway farm.", "nullable": true }, "AccessGatewayTags": { "title": "String[]", "type": "array", "description": "Access Gateway tags.", "nullable": true, "items": { "title": "String", "type": "string" } }, "IsUsingWanScaler": { "title": "Boolean", "type": "boolean", "description": "Using WanScaler (NetScaler SD-WAN)." } } }, "SimulationResponseContract": { "title": "SimulationResponseContract", "type": "object", "description": "Result of a simulation run.", "additionalProperties": false, "properties": { "IsUserRsop": { "title": "Boolean", "type": "boolean", "description": "The report is for machine or user." }, "FilterEvidence": { "title": "Dictionary`2", "type": "object", "description": "Filter evidence used for the simulation.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "AppliedSettings": { "title": "AppliedSetting[]", "type": "array", "description": "Applied settings.", "nullable": true, "items": { "$ref": "#/components/schemas/AppliedSetting" } }, "AppliedPolicies": { "title": "AppliedPolicy[]", "type": "array", "description": "Applied policies.", "nullable": true, "items": { "$ref": "#/components/schemas/AppliedPolicy" } }, "LosingSettings": { "title": "LosingSetting[]", "type": "array", "description": "Settings that did not get applied.", "nullable": true, "items": { "$ref": "#/components/schemas/LosingSetting" } }, "LosingPolicies": { "title": "LosingPolicy[]", "type": "array", "description": "Policies that did not get applied. Some of them should be applied in theory but not applied in practice.", "nullable": true, "items": { "$ref": "#/components/schemas/LosingPolicy" } } } }, "SiteBackupScheduleDetailResponseModel": { "title": "SiteBackupScheduleDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/ScheduleDetailResponseModel" }, { "type": "object", "description": "The response model for Site backup schedule details.", "additionalProperties": false, "properties": { "Day": { "description": "Day", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "DaysInWeek": { "title": "BackupRestoreScheduleDays[]", "type": "array", "description": "Days in Week", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreScheduleDays" } }, "DayInMonth": { "description": "Days in Month", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "WeekInMonth": { "description": "Weeks in Month", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleWeeks" }, "StartDate": { "title": "String", "type": "string", "description": "Start Date", "nullable": true }, "FrequencyFactor": { "title": "Int32", "type": "integer", "description": "Frequency Factor", "format": "int32", "nullable": true }, "TimeZoneId": { "title": "String", "type": "string", "description": "Time Zone Id\n ", "nullable": true }, "LastRunTime": { "title": "String", "type": "string", "description": "Last Run Time", "nullable": true } } } ] }, "SiteBackupTaskDetailResponseModel": { "title": "SiteBackupTaskDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/TaskDetailResponseModel" }, { "type": "object", "description": "The response model for Site backup schedule details.", "additionalProperties": false, "properties": { "Pinned": { "title": "Boolean", "type": "boolean", "description": "Pinned = true, unpinned = false" }, "HistoryUid": { "title": "Int32", "type": "integer", "description": "Hisotry Uid", "format": "int32" }, "RelatedUid": { "title": "Int32", "type": "integer", "description": "Related history UID", "format": "int32" }, "RelatedDate": { "title": "DateTime", "type": "string", "description": "Related history Date/Time", "format": "date-time" }, "RelatedIsCheckMode": { "title": "Boolean", "type": "boolean", "description": "Related Restore was run in check mode" }, "Details": { "title": "Dictionary`2", "type": "object", "description": "Details", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "Result": { "title": "Boolean", "type": "boolean", "description": "Result" }, "BackupSize": { "title": "Int64", "type": "integer", "description": "Backup size in bytes", "format": "int64" }, "BackupSchedule": { "description": "Backup schedule that created this backup.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" } } } ] }, "SiteConfigurationProfileModel": { "title": "SiteConfigurationProfileModel", "type": "object", "additionalProperties": false, "properties": { "DatabaseServerEdition": { "description": "The database server edition used by the site.", "$ref": "#/components/schemas/DatabaseServerEdition" }, "DatabaseAuthenticationMode": { "description": "The database authentication mode used by the site.", "$ref": "#/components/schemas/DatabaseAuthenticationMode" } } }, "SiteCriticalIssueType": { "title": "SiteCriticalIssueType", "type": "string", "description": "The type of the site critical issue.", "x-enumNames": [ "Unknown", "InitialZoneHasResources" ], "enum": [ "Unknown", "InitialZoneHasResources" ] }, "SiteDetailResponseModel": { "title": "SiteDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/SiteResponseModel" }, { "type": "object", "description": "Site response model.", "additionalProperties": false, "required": [ "OrchestationApiVersion", "PrimaryZone", "ProductCode", "ProductEdition", "ProductVersion", "SiteServices", "EnabledFeatures", "ColorDepth", "DefaultDesktopIconId" ], "properties": { "OrchestationApiVersion": { "title": "Int32", "type": "integer", "description": "Orchestration API version", "format": "int32" }, "AppProtectionAuthorized": { "title": "Boolean", "type": "boolean" }, "ConfigurationServiceGroupUid": { "title": "String", "type": "string", "description": "The Uid for the Configuration Service Group.", "nullable": true }, "LicenseServerName": { "title": "String", "type": "string", "description": "Hostname of the licensing server for the site.\nWill be null for XenApp & XenDesktop service.", "nullable": true }, "LicenseServerPort": { "title": "Int32", "type": "integer", "description": "License server port.\nWill be null for XenApp & XenDesktop service.", "format": "int32", "nullable": true }, "LicenseServerUri": { "title": "String", "type": "string", "description": "License server URI.\nWill be null for XenApp & XenDesktop service.", "nullable": true }, "LicensingModel": { "description": "Licensing model.", "nullable": true, "$ref": "#/components/schemas/LicenseModel" }, "SiteConfigurationComplete": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the site's initial configuration is complete." }, "SiteConfigurationProfile": { "description": "The configuration profile for the site, including database server edition and database authentication mode.", "nullable": true, "$ref": "#/components/schemas/SiteConfigurationProfileModel" }, "PrimaryZone": { "description": "Primary zone for the site.", "$ref": "#/components/schemas/RefResponseModel" }, "ProductCode": { "title": "String", "type": "string", "description": "Product code for the site license.", "minLength": 1 }, "ProductEdition": { "title": "String", "type": "string", "description": "Product edition for the site license.", "minLength": 1 }, "ProductVersion": { "title": "String", "type": "string", "description": "Product version.", "minLength": 1 }, "LicenseExpirationDate": { "title": "String", "type": "string", "description": "The expiration date( in UTC) of the license selected. Only availiable for On-Prem deployment.", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of Site.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "SiteGuid": { "title": "String", "type": "string", "description": "The site unique id.", "nullable": true }, "CriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "The critical issue of the site", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfSiteCriticalIssueType" } }, "NonCriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "The non-critical issue of the site", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfSiteNonCriticalIssueType" } }, "SiteServices": { "title": "SiteServiceResponseModel[]", "type": "array", "description": "Services running within the site.", "items": { "$ref": "#/components/schemas/SiteServiceResponseModel" } }, "EnabledFeatures": { "title": "String[]", "type": "array", "description": "Enabled features within the site.", "items": { "title": "String", "type": "string" } }, "BaseOU": { "title": "String", "type": "string", "description": "The objectGUID property identifying the base OU in Active Directory used for desktop registrations.", "nullable": true }, "ColorDepth": { "description": "The default color depth for new delivery groups.", "$ref": "#/components/schemas/ColorDepth" }, "ConnectionLeasingEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether connection leasing is enabled." }, "DefaultMinimumFunctionalLevel": { "description": "The default minimum functional level used for new machine catalogs and delivery groups\nwhen no explicit value is provided.", "$ref": "#/components/schemas/FunctionalLevel" }, "DefaultDesktopIconId": { "title": "String", "type": "string", "description": "The default desktop icon used for new delivery groups.", "minLength": 1 }, "DnsResolutionEnabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether numeric IP addresses or DNS names are present in ICA files." }, "LicenseGraceSessionsRemaining": { "title": "Int32", "type": "integer", "description": "The number of licensing grace sessions remaining.", "format": "int32", "nullable": true }, "LicensedSessionsActive": { "title": "Int32", "type": "integer", "description": "The number of active, licensed sessions.", "format": "int32", "nullable": true }, "LicensingGraceHoursLeft": { "title": "Int32", "type": "integer", "description": "When in an active licensing grace period, indicates the\nnumber of hours remaining in the grace period.\nWill be null for XenApp & XenDesktop service.", "format": "int32", "nullable": true }, "LicensingGracePeriodActive": { "title": "Boolean", "type": "boolean", "description": "Indicates whether a licensing grace period is active.\nWill be null for XenApp & XenDesktop service.", "nullable": true }, "LicensingOutOfBoxGracePeriodActive": { "title": "Boolean", "type": "boolean", "description": "The indicator for licensing out of the box grace period active.", "nullable": true }, "PeakConcurrentLicenseUsers": { "title": "Int32", "type": "integer", "description": "The peak number of concurrent licensed users.\nOnly applies if LicensingModel is Concurrent.", "format": "int32", "nullable": true }, "ReuseMachinesWithoutShutdownInOutageAllowed": { "title": "Boolean", "type": "boolean", "description": "Allow sessions to launch on shared machines without an intermediate shutdown\nwhile the system is operating in outage mode." }, "DefaultSecureIcaRequired": { "title": "Boolean", "type": "boolean", "description": "The default SecureICA usage for new delivery groups." }, "TotalUniqueLicenseUsers": { "title": "Int32", "type": "integer", "description": "The total count of unique license users.", "format": "int32", "nullable": true }, "TrustRequestsSentToTheXmlServicePort": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the XML service trusts the caller to specify user identity.", "nullable": true }, "LicensesWithExpiredSwm": { "title": "String", "type": "string", "description": "The list of licenses with expired software maintenance dates.", "nullable": true }, "GpoDataNoError": { "title": "Boolean", "type": "boolean", "description": "Status of the Policy GPOBlob to policySet conversion.", "nullable": true }, "BrokerServiceGroupUid": { "title": "String", "type": "string", "description": "The broker service group unique id.", "nullable": true }, "EntraIdSetting": { "description": "Entra ID settings for the site.", "nullable": true, "$ref": "#/components/schemas/EntraIdSettingModel" }, "LicensingAlerts": { "title": "LicensingAlertResponseModel[]", "type": "array", "description": "Get active licensing alerts in the site.\nWill be null for XenApp & XenDesktop service.", "nullable": true, "items": { "$ref": "#/components/schemas/LicensingAlertResponseModel" } } } } ] }, "SiteErrorWarningModel": { "title": "SiteErrorWarningModel", "type": "object", "additionalProperties": false, "properties": { "Category": { "description": "Indicate the category, error or warning.", "$ref": "#/components/schemas/MisConfigurationCategory" }, "Type": { "title": "String", "type": "string", "description": "The error or warning message.", "nullable": true }, "TimeInUtc": { "title": "String", "type": "string", "description": "The time of the error or warning in UTC.", "nullable": true }, "IsHighPriority": { "title": "Boolean", "type": "boolean", "description": "Indicate whether the error or warning is high priority." } } }, "SiteNonCriticalIssueType": { "title": "SiteNonCriticalIssueType", "type": "string", "description": "The type of the site non-critical issue", "x-enumNames": [ "Unknown", "ExceedsHostConnectionsPerSite", "SfAdvHealthCheckNotConfigured", "ServiceContinuityNotEnabled" ], "enum": [ "Unknown", "ExceedsHostConnectionsPerSite", "SfAdvHealthCheckNotConfigured", "ServiceContinuityNotEnabled" ] }, "SiteResponseModel": { "title": "SiteResponseModel", "type": "object", "description": "Site response model.", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "Id": { "title": "String", "type": "string", "description": "Globally unique id of the site.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Site name. Not guaranteed to be unique.", "minLength": 1 } } }, "SiteResponseModelCollection": { "title": "SiteResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfSiteResponseModel" }, { "type": "object", "description": "Response object for collections of SiteResponseModel.", "additionalProperties": false } ] }, "SitesErrorWarningModel": { "title": "SitesErrorWarningModel", "allOf": [ { "$ref": "#/components/schemas/ErrorWarningModel" }, { "type": "object", "additionalProperties": false, "properties": { "ErrorWarning": { "title": "SiteErrorWarningModel[]", "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/SiteErrorWarningModel" } } } } ] }, "SiteServiceResponseModel": { "title": "SiteServiceResponseModel", "type": "object", "description": "Service capabilities.", "additionalProperties": false, "required": [ "ServiceName", "ServiceType", "Capabilities" ], "properties": { "ServiceName": { "title": "String", "type": "string", "description": "Name of the service.", "minLength": 1 }, "ServiceType": { "title": "String", "type": "string", "description": "Type of the service, which will not be changed across languages.", "minLength": 1 }, "CurrentSchemaVersion": { "title": "String", "type": "string", "description": "Current schema version of the service.\nWill be `null` for XenApp & XenDesktop service.", "nullable": true }, "DesiredSchemaVersion": { "title": "String", "type": "string", "description": "Desired schema version of the service.\nWill be `null` for XenApp & XenDesktop service.", "nullable": true }, "Capabilities": { "title": "String[]", "type": "array", "description": "List of capabilities exposed by the service.", "items": { "title": "String", "type": "string" } } } }, "SiteSettingsResponseModel": { "title": "SiteSettingsResponseModel", "type": "object", "description": "The site settings response model.", "additionalProperties": false, "properties": { "UseVerticalScalingForRdsLaunches": { "title": "Boolean", "type": "boolean", "nullable": true }, "DnsResolutionEnabled": { "title": "Boolean", "type": "boolean", "nullable": true }, "TrustRequestsSentToTheXmlServicePortEnabled": { "title": "Boolean", "type": "boolean", "nullable": true }, "WebUiPolicySetEnabled": { "title": "Boolean", "type": "boolean", "description": "The policy set in web UI is enabled or not", "nullable": true }, "ConsoleInactivityTimeoutMinutes": { "title": "Int32", "type": "integer", "description": "The max number of minutes that console can be inactive.", "format": "int32", "nullable": true }, "SupportedAuthenticators": { "description": "Applicable only for On-Premise.\nDetermine the supported authentication methods.", "nullable": true, "$ref": "#/components/schemas/Authenticator" }, "ShowSecurityBannerOnLoginPage": { "title": "Boolean", "type": "boolean", "description": "Applicable only for On-Premise.\nIndicate whether to display security banner on the login page.", "nullable": true }, "SecurityBannerOnLoginPage": { "title": "String", "type": "string", "description": "Applicable only for On-Premise.\nThe custom security banner on the login page, max length is 5000.", "nullable": true }, "ShowConnectedControllerOnLoginPage": { "title": "Boolean", "type": "boolean", "description": "Applicable only for On-Premise.\nIndicate whether to display the DDC used for the current Studio session on the login page.", "nullable": true }, "AllowedCorsOriginsForIwa": { "title": "String[]", "type": "array", "description": "Application only for On-Premise.\nList of origins allowed to make cross-origin requests for Integrated Windows Authentication.", "nullable": true, "items": { "title": "String", "type": "string" } }, "MultiSites": { "title": "MultiSiteModel[]", "type": "array", "description": "Applicable only for On-Premise\nMultiple sites configuration", "nullable": true, "items": { "$ref": "#/components/schemas/MultiSiteModel" } }, "DefaultDomain": { "title": "String", "type": "string", "description": "The default domain to be used in the login page.", "nullable": true }, "XmlServicesSslConfigurations": { "title": "NameValueStringPairModel[]", "type": "array", "description": "XML service configurations of enabling listening for https/http requests. Only applicable for On-Premise deployments.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "MultiTenantServicesAccess": { "description": "Indicate whether Citrix Cloud Services are allowed to access the DaaS.", "nullable": true, "$ref": "#/components/schemas/MultiTenantServicesAccessModel" }, "AotSetting": { "description": "The AOT setting", "nullable": true, "$ref": "#/components/schemas/AotSettingResponseModel" }, "EntraIdSetting": { "description": "The Entra ID settings.", "nullable": true, "$ref": "#/components/schemas/EntraIdSettingModel" } } }, "SiteState": { "title": "SiteState", "type": "string", "description": "Site state.", "x-enumNames": [ "Unknown", "Configured", "Unconfigured", "UpgradeRequired", "Error" ], "enum": [ "Unknown", "Configured", "Unconfigured", "UpgradeRequired", "Error" ] }, "SiteStatusResponseModel": { "title": "SiteStatusResponseModel", "type": "object", "description": "Site status.", "additionalProperties": false, "required": [ "SiteState" ], "properties": { "SiteState": { "description": "State of the site.", "$ref": "#/components/schemas/SiteState" }, "CurrentUserCanPerformUpgrade": { "title": "Boolean", "type": "boolean", "description": "If the current administrator can perform upgrade." }, "UpgradedControllers": { "title": "String[]", "type": "array", "description": "These controllers have been upgraded and will function normally at the latest version.\n ", "nullable": true, "items": { "title": "String", "type": "string" } }, "ControllersRequiringBinaryUpgrade": { "title": "String[]", "type": "array", "description": "These controllers require their binaries to be upgraded to bring them inline with the rest of the site.", "nullable": true, "items": { "title": "String", "type": "string" } }, "LatestControllerVersion": { "title": "String", "type": "string", "description": "The highest of all controller versions in the site. All controllers should be upgraded to this version.", "nullable": true }, "DatabaseServersRequiringUpgrade": { "title": "String[]", "type": "array", "description": "These database servers must be upgraded to be compatible with the site controllers.", "nullable": true, "items": { "title": "String", "type": "string" } }, "DataStoresRequiringUpgrade": { "title": "String[]", "type": "array", "description": "The database versions for these data stores are older than what is required by the most up-to-date controllers.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "SiteTestResponseModel": { "title": "SiteTestResponseModel", "type": "object", "description": "Response object for a site test result.", "additionalProperties": false, "required": [ "Site", "NumPassed", "NumWarnings", "NumFailures" ], "properties": { "Site": { "description": "The site upon which the test was run.", "$ref": "#/components/schemas/RefResponseModel" }, "NumPassed": { "title": "Int32", "type": "integer", "description": "The number of tests that passed.", "format": "int32" }, "NumWarnings": { "title": "Int32", "type": "integer", "description": "The number of warnings that were found.", "format": "int32" }, "NumFailures": { "title": "Int32", "type": "integer", "description": "The number of tests that failed.", "format": "int32" }, "TestReport": { "description": "The detailed test report, only included when specifically requested in the API call.", "nullable": true, "$ref": "#/components/schemas/TestReportResponseModel" } } }, "SmartAccessTagRequestModel": { "title": "SmartAccessTagRequestModel", "type": "object", "description": "Request object specifying properties of a NetScaler SmartAccess Tag.", "additionalProperties": false, "required": [ "Farm", "Filter" ], "properties": { "Farm": { "title": "String", "type": "string", "description": "SmartAccess Farm name.", "minLength": 1, "example": "Farm name" }, "Filter": { "title": "String", "type": "string", "description": "SmartAccess filter name.", "minLength": 1, "example": "Filter name" } } }, "SmartAccessTagResponseModel": { "title": "SmartAccessTagResponseModel", "type": "object", "description": "Response object for a NetScaler SmartAccess Tag.", "additionalProperties": false, "required": [ "Farm", "Filter" ], "properties": { "Farm": { "title": "String", "type": "string", "description": "SmartAccess farm name.", "minLength": 1 }, "Filter": { "title": "String", "type": "string", "description": "SmartAccess filter name.", "minLength": 1 } } }, "SortingMethod": { "title": "SortingMethod", "type": "object", "description": "Policy set search result sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/SearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "SortingMethod2": { "title": "SortingMethod", "type": "object", "description": "Policy search result sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/PolicyProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "SortingMethod3": { "title": "SortingMethod", "type": "object", "description": "Setting search result sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/SettingProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "SortingMethod4": { "title": "SortingMethod", "type": "object", "description": "Filter search result sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/FilterProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "StartMenuApplicationResponseModel": { "title": "StartMenuApplicationResponseModel", "type": "object", "description": "Response object for a start menu application.", "additionalProperties": false, "required": [ "CommandLineExecutable", "DisplayName", "ShortcutPath", "Machine" ], "properties": { "CommandLineArguments": { "title": "String", "type": "string", "description": "Command line arguments.", "nullable": true }, "CommandLineExecutable": { "title": "String", "type": "string", "description": "Command line executable.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description.", "nullable": true }, "DisplayName": { "title": "String", "type": "string", "description": "Display name.", "minLength": 1 }, "ShortcutPath": { "title": "String", "type": "string", "description": "Path to the shortcut within the start menu.", "minLength": 1 }, "WorkingDirectory": { "title": "String", "type": "string", "description": "Working directory.", "nullable": true }, "Machine": { "description": "Machine from which the start menu application was obtained.", "$ref": "#/components/schemas/RefResponseModel" } } }, "StartMenuApplicationResponseModelCollection": { "title": "StartMenuApplicationResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfStartMenuApplicationResponseModel" }, { "type": "object", "description": "The collection of StartMenuApplicationResponseModel", "additionalProperties": false } ] }, "StatusModel": { "title": "StatusModel", "type": "object", "description": "The status of the product.", "additionalProperties": false, "properties": { "OrchServiceVersion": { "title": "String", "type": "string", "description": "The Orchestration service version.", "nullable": true }, "ProductInternalVersion": { "title": "String", "type": "string", "description": "The Product internal version.", "nullable": true }, "ProductExternalVersion": { "title": "String", "type": "string", "description": "The product external version.", "nullable": true }, "OrchServiceStatus": { "description": "The Orchestration service status.", "$ref": "#/components/schemas/ServiceStatus" }, "OrchRESTFulApiStatus": { "description": "The Orchestration RESTFul Api running status.", "$ref": "#/components/schemas/RestApiStatus" }, "SupportedAuthenticators": { "description": "The supported authentication methods.", "nullable": true, "$ref": "#/components/schemas/Authenticator" }, "ShowSecurityBannerOnLoginPage": { "title": "Boolean", "type": "boolean", "description": "Indicate whether to display security banner on the login page.", "nullable": true }, "SecurityBannerOnLoginPage": { "title": "String", "type": "string", "description": "The custom security banner on the login page.", "nullable": true }, "ShowConnectedControllerOnLoginPage": { "title": "Boolean", "type": "boolean", "description": "Indicate whether to display the DDC used for the current Studio session on the login page.", "nullable": true } } }, "StorageBalanceType": { "title": "StorageBalanceType", "type": "string", "description": "Known types for storage balance type", "x-enumNames": [ "Unknown", "None", "VMCountBasedLeastLoad" ], "enum": [ "Unknown", "None", "VMCountBasedLeastLoad" ] }, "StoreFrontDeliveryGroupResponseModel": { "title": "StoreFrontDeliveryGroupResponseModel", "type": "object", "additionalProperties": false, "properties": { "DeliveryGroupUid": { "title": "Int32", "type": "integer", "description": "Gets or sets the DeliveryGroupUid.", "format": "int32" }, "DeliveryGroupName": { "title": "String", "type": "string", "description": "Gets or sets the DeliveryGroupName.", "nullable": true } } }, "StoreFrontDeliveryGroupResponseModelCollection": { "title": "StoreFrontDeliveryGroupResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfStoreFrontDeliveryGroupResponseModel" }, { "type": "object", "additionalProperties": false } ] }, "StoreFrontServerRequestModel": { "title": "StoreFrontServerRequestModel", "type": "object", "description": "Request object for specifying StoreFront URLs to configure\nwithin Receivers when they are hosted on a VDA.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "ID of an existing StoreFront server. If specified, this must be the\nonly property specified in the request model.", "nullable": true, "example": "Id of an StoreFront server" }, "Name": { "title": "String", "type": "string", "description": "Name of the StoreFront server.", "maxLength": 64, "pattern": "(.*)*", "nullable": true, "example": "Name of an StoreFront server" }, "Description": { "title": "String", "type": "string", "description": "Description of the StoreFront server.", "maxLength": 512, "pattern": "(.*)*", "nullable": true, "example": "Description of the StoreFront server" }, "Url": { "title": "String", "type": "string", "description": "Url of the StoreFront server.", "maxLength": 2000, "pattern": "UNKNOWN", "nullable": true, "example": "For example, http://url.to.StoreFront.server" }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Whether the StoreFront server is enabled. Disabled StoreFront\nservers will not have thier URLs added to hosted receiver.", "default": true, "nullable": true } } }, "StoreFrontServerResponseModel": { "title": "StoreFrontServerResponseModel", "type": "object", "description": "Request object indicating StoreFront URLs to configure\nwithin Receivers when they are hosted on a VDA.", "additionalProperties": false, "required": [ "Id", "Name", "Url", "Enabled" ], "properties": { "Id": { "title": "String", "type": "string", "description": "ID of the StoreFront server.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the StoreFront server.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of the StoreFront server.", "nullable": true }, "Url": { "title": "String", "type": "string", "description": "Url of the StoreFront server.", "minLength": 1 }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the StoreFront server is enabled.\nDisabled StoreFront servers will not have their\nURLs added to hosted receiver." }, "DesktopGroupRefCount": { "title": "Int32", "type": "integer", "description": "DesktopGroupRefCount", "format": "int32" } } }, "StoreFrontServerResponseModelCollection": { "title": "StoreFrontServerResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfStoreFrontServerResponseModel" }, { "type": "object", "description": "StoreFront server response model collection", "additionalProperties": false } ] }, "StudioSettingsResponseModel": { "title": "StudioSettingsResponseModel", "type": "object", "description": "Response model for WebStudio related settings", "additionalProperties": false, "properties": { "MultiSites": { "title": "MultiSiteModel[]", "type": "array", "description": "Multiple sites configuration", "nullable": true, "items": { "$ref": "#/components/schemas/MultiSiteModel" } }, "DefaultDomain": { "title": "String", "type": "string", "description": "The default domain to be used in the login page.", "nullable": true } } }, "SummaryState": { "title": "SummaryState", "type": "string", "description": "Overall summary state of the desktop associated with a machine.", "x-enumNames": [ "Unknown", "Off", "Unregistered", "Available", "Disconnected", "InUse", "Preparing" ], "enum": [ "Unknown", "Off", "Unregistered", "Available", "Disconnected", "InUse", "Preparing" ] }, "SummaryType": { "title": "Nullable`1", "type": "string", "description": "Types of cost summary.", "x-enumNames": [ "VM", "Disk" ], "enum": [ "VM", "Disk" ] }, "SupportedPowerAction": { "title": "SupportedPowerAction", "type": "string", "description": "Power actions which may be supported by a machine.", "x-enumNames": [ "Unknown", "PowerOn", "PowerOff", "SuspendResume", "Restart", "Reset", "Shutdown" ], "enum": [ "Unknown", "PowerOn", "PowerOff", "SuspendResume", "Restart", "Reset", "Shutdown" ] }, "TagDetailResponseModel": { "title": "TagDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/TagResponseModel" }, { "type": "object", "description": "Detail response object for a tag.", "additionalProperties": false, "required": [ "RestrictedDesktops", "RestrictedApplicationGroups", "RestrictedDeliveryGroups", "RestrictedRebootSchedules", "NumUnknownRestrictedObjects" ], "properties": { "RestrictedDesktops": { "title": "RefResponseModel[]", "type": "array", "description": "Desktops which are restricted to be used with machines that are tagged with this tag.", "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "RestrictedApplicationGroups": { "title": "RefResponseModel[]", "type": "array", "description": "Application groups which are restricted such that the applications contained within\nwill be launched only on machines that are tagged with this tag.", "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "RestrictedDeliveryGroups": { "title": "RefResponseModel[]", "type": "array", "description": "Delivery groups with reboot schedules that are restricted to machines that are\ntagged with this tag.", "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "RestrictedRebootSchedules": { "title": "RefResponseModel[]", "type": "array", "description": "Reboot schedules that are restricted to machines that are tagged with this tag.\nOnly reboot schedules that are visible to the calling delegated administrator are counted.", "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "RestrictedAutoscale": { "title": "RefResponseModel[]", "type": "array", "description": "Delivery groups that are using this tag for autoscale", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "NumUnknownRestrictedObjects": { "title": "Int32", "type": "integer", "description": "The number of objects of all types that have this tag restriction and that are\n*not* visible to the calling delegated administrator.", "format": "int32" } } } ] }, "TagRequestModel": { "title": "TagRequestModel", "type": "object", "description": "Request object for tags.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the tag.", "nullable": true, "example": "Name of the tag" }, "Description": { "title": "String", "type": "string", "description": "Description of the tag.", "nullable": true, "example": "Description of the tag" }, "Uuid": { "title": "String", "type": "string", "description": "Unique Id of the tag.", "nullable": true, "example": "Description of the tag" }, "Scopes": { "title": "String[]", "type": "array", "description": "Name of the Scopes.", "nullable": true, "example": [ "Name of the tag" ], "items": { "title": "String", "type": "string" } } } }, "TagResponseModel": { "title": "TagResponseModel", "type": "object", "description": "Response object for a tag.", "additionalProperties": false, "required": [ "Name", "Id", "NumMachines", "NumApplications", "NumApplicationGroups", "NumMachineCatalogs", "NumDeliveryGroups", "NumUnknownObjects" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name of the tag.", "minLength": 1 }, "Id": { "title": "String", "type": "string", "description": "Id of the tag.\nUsed to be: Guid\nNeeds to be globally unique\nThis is likely to contain a guid but the property type should be string for future flexibility", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of the tag.", "nullable": true }, "Uid": { "title": "Int32", "type": "integer", "description": "`DEPRECATED` DEPRECATED. Use Id.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED", "nullable": true }, "IsUsedByGpo": { "title": "Boolean", "type": "boolean", "description": "Used by Gpo or not." }, "NumMachines": { "title": "Int32", "type": "integer", "description": "Number of machines the tag is applied to, within the context of the query.", "format": "int32" }, "NumApplications": { "title": "Int32", "type": "integer", "description": "Number of applications the tag is applied to, within the context of the query.", "format": "int32" }, "NumApplicationGroups": { "title": "Int32", "type": "integer", "description": "Number of application groups the tag is applied to, within the context of the query.", "format": "int32" }, "NumMachineCatalogs": { "title": "Int32", "type": "integer", "description": "Number of machine catalogs the tag is applied to, within the context of the query.", "format": "int32" }, "NumDeliveryGroups": { "title": "Int32", "type": "integer", "description": "Number of delivery groups the tag is applied to, within the context of the query.", "format": "int32" }, "NumAutoscale": { "title": "Int32", "type": "integer", "description": "Number of delivery groups using this tag for Autoscale, within the context of the query.", "format": "int32" }, "NumDesktops": { "title": "Int32", "type": "integer", "description": "Number of desktops( entitlement policy rules) using this tag, within the context of the query.", "format": "int32" }, "NumUnknownObjects": { "title": "Int32", "type": "integer", "description": "The number of objects of all types that are tagged with this tag and that are\n*not* visible to the calling delegated administrator.", "format": "int32" }, "ScopeReferences": { "title": "ScopeReferenceModel[]", "type": "array", "description": "The list of the delegated admin scopes to which the tag belongs.", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeReferenceModel" } } } }, "TagResponseModelCollection": { "title": "TagResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfTagResponseModel" }, { "type": "object", "description": "Tag response collection", "additionalProperties": false } ] }, "TagsRequestModel": { "title": "TagsRequestModel", "type": "object", "description": "Request object allowing caller to specify a list of\ntags to associate with an object.", "additionalProperties": false, "properties": { "Items": { "title": "String[]", "type": "array", "description": "List of references to tags.", "nullable": true, "example": [ "For example", " name of a tag" ], "items": { "title": "String", "type": "string" } }, "CreateTags": { "title": "TagRequestModel[]", "type": "array", "description": "List of tags to both create and associate with the object.", "nullable": true, "items": { "$ref": "#/components/schemas/TagRequestModel" } }, "DeleteTags": { "title": "String[]", "type": "array", "description": "List of tags to delete from the site. This removes the tag not only from the referenced\nobject, but from *all* objects within the site, and also deletes the tag itself.", "nullable": true, "example": [ "For example", " name of a tag to delete" ], "items": { "title": "String", "type": "string" } } } }, "TakeVMBackupTaskDetailResponseModel": { "title": "TakeVMBackupTaskDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/MaintenanceCycleTaskDetailResponseModel" }, { "type": "object", "description": "Response object for a task of take vm backup.", "additionalProperties": false, "properties": { "ProvisionedBackupName": { "title": "String", "type": "string", "description": "The name of the backup.", "nullable": true }, "ProvisionedBackupDescription": { "title": "String", "type": "string", "description": "The description of the backup.", "nullable": true }, "ShutdownMachines": { "title": "Boolean", "type": "boolean", "description": "Whether to shutdown the virtual machine when taking backup." } } } ] }, "TaskDetailResponseModel": { "title": "TaskDetailResponseModel", "properties": { "ProvisionedVmConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The version of provisioned VM configuration version. It is the version applied when the VM hardware update is created.", "format": "int32", "nullable": true }, "ProvisioningSchemeConfigurationVersion": { "title": "Int32", "type": "integer", "description": "The version of provisioning scheme version. It is the version applied when the VM hardware update is created.", "format": "int32", "nullable": true }, "MasterImage": { "description": "The master image assignment applied to the provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "ImageVersionSpec": { "description": "The image version assignment applied to the provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/ImageVersionSpecRefResponseModel" }, "RolloutStrategy": { "description": "Rollout strategy for updating VMs with the new image.", "$ref": "#/components/schemas/RolloutStrategy" }, "ProvisionedBackupName": { "title": "String", "type": "string", "description": "The name of the backup.", "nullable": true }, "ProvisionedBackupDescription": { "title": "String", "type": "string", "description": "The description of the backup.", "nullable": true }, "ShutdownMachines": { "title": "Boolean", "type": "boolean", "description": "Whether to shutdown the virtual machine when taking backup." }, "ProvisionedBackupId": { "title": "String", "type": "string", "description": "The id of the backup.", "nullable": true }, "ProvisionedBackupRestoreType": { "description": "The type of how the backup being restored.", "$ref": "#/components/schemas/ProvisionedBackupRestoreType" }, "ProvisioningSchemeName": { "title": "String", "type": "string", "description": "The name of provisioning scheme.", "nullable": true }, "ProvisioningSchemeUid": { "title": "String", "type": "string", "description": "The uid of provisioning scheme.", "nullable": true }, "PurgeDBAfter": { "title": "Int32", "type": "integer", "description": "Purge task data after a certain number of days.", "format": "int32", "nullable": true }, "SessionWarningLogOffTitle": { "title": "String", "type": "string", "description": "The title of session log off warning. ", "nullable": true }, "SessionWarningLogOffMessage": { "title": "String", "type": "string", "description": "The message of session log off warning.", "nullable": true }, "SessionWarningTime": { "title": "Int32", "type": "integer", "description": "The countdown duration for session log off, in minutes.", "format": "int32", "nullable": true }, "AllVms": { "title": "Boolean", "type": "boolean", "description": "If maintenance cycle created base on machine catalog." }, "NewVmsOnly": { "title": "Boolean", "type": "boolean", "description": "If maintenance cycle oly applies to new VMs." }, "MaxDuration": { "title": "Int32", "type": "integer", "description": "The max duration for the task to execute, in minutes.", "format": "int32", "nullable": true }, "Pinned": { "title": "Boolean", "type": "boolean", "description": "Pinned = true, unpinned = false" }, "HistoryUid": { "title": "Int32", "type": "integer", "description": "Hisotry Uid", "format": "int32" }, "RelatedUid": { "title": "Int32", "type": "integer", "description": "Related history UID", "format": "int32" }, "RelatedDate": { "title": "DateTime", "type": "string", "description": "Related history Date/Time", "format": "date-time" }, "RelatedIsCheckMode": { "title": "Boolean", "type": "boolean", "description": "Related Restore was run in check mode" }, "Details": { "title": "Dictionary`2", "type": "object", "description": "Details", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } }, "Result": { "title": "Boolean", "type": "boolean", "description": "Result" }, "BackupSize": { "title": "Int64", "type": "integer", "description": "Backup size in bytes", "format": "int64" }, "BackupSchedule": { "description": "Backup schedule that created this backup.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" } }, "allOf": [ { "$ref": "#/components/schemas/TaskResponseModel" }, { "type": "object", "description": "Response object for a task.", "additionalProperties": false, "properties": { "Type": { "description": "Type of task", "$ref": "#/components/schemas/TaskType" } } } ] }, "TaskRefResponseModel": { "title": "TaskRefResponseModel", "type": "object", "description": "Reference response object for a task.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Task Id. This is a composite Id made up of the TaskType and the underlying task identifier.", "nullable": true }, "Status": { "description": "Task status.", "$ref": "#/components/schemas/TaskStatus" }, "Type": { "description": "Task type.", "$ref": "#/components/schemas/TaskType" } } }, "TaskResponseModel": { "title": "TaskResponseModel", "type": "object", "description": "Response object for a task.", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "Task Id. This is a composite Id made up of the TaskType and the underlying task identifier.", "nullable": true }, "Status": { "description": "Task status.", "$ref": "#/components/schemas/TaskStatus" }, "Type": { "description": "Task type.", "$ref": "#/components/schemas/TaskType" }, "Description": { "title": "String", "type": "string", "description": "Description of the task.", "nullable": true }, "TargetType": { "description": "The target type of the task. Different types of tasks may have different targets.Also Targets.", "$ref": "#/components/schemas/TaskTargetType" }, "Targets": { "title": "RefResponseModel[]", "type": "array", "description": "The targets of the task. Different types of tasks may have different targets. Also TargetType.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } }, "CreationTime": { "title": "String", "type": "string", "description": "The creation time of the task.\nRFC 3339 compatible format.", "nullable": true }, "StartTime": { "title": "String", "type": "string", "description": "The start time for the task.\nRFC 3339 compatible format.", "nullable": true }, "EndTime": { "title": "String", "type": "string", "description": "The end time for the task.\nRFC 3339 compatible format.", "nullable": true }, "CreatedBy": { "title": "String", "type": "string", "description": "The user who created the task.", "nullable": true } } }, "TaskResponseModelCollection": { "title": "TaskResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfTaskResponseModel" }, { "type": "object", "additionalProperties": false } ] }, "TaskSearchFilterGroupRequestModel": { "title": "TaskSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for tasks.", "additionalProperties": false, "properties": { "SearchFilters": { "title": "TaskSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSearchFilterRequestModel" } }, "SearchFilterGroupType": { "description": "The type of how the search filter in SearchFilters are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" }, "SearchFilterGroups": { "title": "TaskSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of how the search filter groups in SearchFilterGroups are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" } } }, "TaskSearchFilterRequestModel": { "title": "TaskSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for tasks.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/TaskSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true, "example": "For example, test" }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "TaskSearchProperty": { "title": "TaskSearchProperty", "type": "string", "description": "Defines properties for searching tasks.", "x-enumNames": [ "Unknown", "Id", "Description", "EndTime", "StartTime", "CreationTime", "Status", "TargetType", "Type", "TargetName" ], "enum": [ "Unknown", "Id", "Description", "EndTime", "StartTime", "CreationTime", "Status", "TargetType", "Type", "TargetName" ] }, "TaskSearchRequestModel": { "title": "TaskSearchRequestModel", "type": "object", "description": "Request model for defining advanced task search criteria.", "additionalProperties": false, "properties": { "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the task.", "nullable": true }, "SearchFilters": { "title": "TaskSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSearchFilterRequestModel" } }, "SortCriteria": { "description": "Sort criteria for the results.", "nullable": true, "$ref": "#/components/schemas/TaskSortCriteriaRequestModel" }, "SearchFilterGroups": { "title": "TaskSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of how the search filter groups in SearchFilterGroups are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" }, "SortCriteriaItems": { "title": "TaskSortCriteriaRequestModel[]", "type": "array", "description": "Sort criteria for the results, multiple sorting criteria can be specified here.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSortCriteriaRequestModel" } } } }, "TaskSortCriteriaRequestModel": { "title": "TaskSortCriteriaRequestModel", "type": "object", "description": "Task sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/TaskSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "TaskStatus": { "title": "TaskStatus", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Scheduled", "InProgress", "Failed", "Cancelled", "Successful", "Cancelling", "PartiallyCompleted", "Rescheduled", "NotProcessed", "Recovering", "Repairing", "Repaired" ], "enum": [ "Unknown", "Scheduled", "InProgress", "Failed", "Cancelled", "Successful", "Cancelling", "PartiallyCompleted", "Rescheduled", "NotProcessed", "Recovering", "Repairing", "Repaired" ] }, "TaskSubJobResponseModel": { "title": "TaskSubJobResponseModel", "type": "object", "additionalProperties": false, "properties": { "Id": { "title": "String", "type": "string", "description": "The sub job id.", "nullable": true }, "Status": { "description": "The status of sub job.", "$ref": "#/components/schemas/TaskSubJobStatus" }, "Information": { "title": "String", "type": "string", "description": "Some information about the sub job.", "nullable": true }, "FailureReason": { "title": "String", "type": "string", "description": "The reason for failed sub job.", "nullable": true }, "TargetName": { "title": "String", "type": "string", "description": "The name of the object the sub job targets to.", "nullable": true }, "TargetSid": { "title": "String", "type": "string", "description": "The Sid of the object the sub job targets to.", "nullable": true }, "StartTime": { "title": "String", "type": "string", "description": "The start time of the sub job.", "nullable": true }, "EndTime": { "title": "String", "type": "string", "description": "The end time of the sub job.", "nullable": true }, "TaskType": { "description": "The task type.", "$ref": "#/components/schemas/TaskType" }, "TaskId": { "title": "String", "type": "string", "description": "The task id.", "nullable": true } } }, "TaskSubJobResponseModelCollection": { "title": "TaskSubJobResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfTaskSubJobResponseModel" }, { "type": "object", "additionalProperties": false } ] }, "TaskSubJobSearchFilterGroupRequestModel": { "title": "TaskSubJobSearchFilterGroupRequestModel", "type": "object", "description": "Advanced search filter group for task sub jobs.", "additionalProperties": false, "properties": { "SearchFilters": { "title": "TaskSubJobSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSubJobSearchFilterRequestModel" } }, "SearchFilterGroupType": { "description": "The type of how the search filter in SearchFilters are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" }, "SearchFilterGroups": { "title": "TaskSubJobSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSubJobSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of how the search filter groups in SearchFilterGroups are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" } } }, "TaskSubJobSearchFilterRequestModel": { "title": "TaskSubJobSearchFilterRequestModel", "type": "object", "description": "Advanced search filter for task sub jobs.", "additionalProperties": false, "required": [ "Property", "Operator" ], "properties": { "Property": { "description": "Property to filter on.", "$ref": "#/components/schemas/TaskSubJobSearchProperty" }, "Value": { "title": "String", "type": "string", "description": "Value to match.", "nullable": true }, "Operator": { "description": "The comparison operator to use when determining\nif an item matches the filter.", "$ref": "#/components/schemas/SearchOperator" } } }, "TaskSubJobSearchProperty": { "title": "TaskSubJobSearchProperty", "type": "string", "description": "Defines properties for searching task sub jobs.", "x-enumNames": [ "Unknown", "TargetName", "TargetSid", "Status", "TaskType", "TaskId", "EndTime", "StartTime" ], "enum": [ "Unknown", "TargetName", "TargetSid", "Status", "TaskType", "TaskId", "EndTime", "StartTime" ] }, "TaskSubJobSearchRequestModel": { "title": "TaskSubJobSearchRequestModel", "type": "object", "description": "Request model for defining advanced task sub job search criteria.", "additionalProperties": false, "properties": { "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match\nif contained within some string property of the task sub job.", "nullable": true }, "SearchFilters": { "title": "TaskSubJobSearchFilterRequestModel[]", "type": "array", "description": "List of advanced search filters.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSubJobSearchFilterRequestModel" } }, "SortCriteria": { "description": "Sort criteria for the results.", "nullable": true, "$ref": "#/components/schemas/TaskSubJobSortCriteriaRequestModel" }, "SearchFilterGroups": { "title": "TaskSubJobSearchFilterGroupRequestModel[]", "type": "array", "description": "List of advanced search filter groups.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSubJobSearchFilterGroupRequestModel" } }, "SearchFilterGroupsType": { "description": "The type of how the search filter groups in SearchFilterGroups are combined.", "nullable": true, "$ref": "#/components/schemas/SearchFilterGroupType" }, "SortCriteriaItems": { "title": "TaskSubJobSortCriteriaRequestModel[]", "type": "array", "description": "Sort criteria for the results, multiple sorting criteria can be specified here.", "nullable": true, "items": { "$ref": "#/components/schemas/TaskSubJobSortCriteriaRequestModel" } } } }, "TaskSubJobSortCriteriaRequestModel": { "title": "TaskSubJobSortCriteriaRequestModel", "type": "object", "description": "Task sub job sort criteria.", "additionalProperties": false, "required": [ "Property", "SortDirection" ], "properties": { "Property": { "description": "Property to sort on.", "$ref": "#/components/schemas/TaskSubJobSearchProperty" }, "SortDirection": { "description": "Direction to sort the property.", "$ref": "#/components/schemas/ListSortDirection" } } }, "TaskSubJobStatus": { "title": "TaskSubJobStatus", "type": "string", "description": "", "x-enumNames": [ "Unknown", "Scheduled", "InProgress", "Failed", "Successful", "NotProcessed", "Repaired", "Cancelled" ], "enum": [ "Unknown", "Scheduled", "InProgress", "Failed", "Successful", "NotProcessed", "Repaired", "Cancelled" ] }, "TaskTargetType": { "title": "TaskTargetType", "type": "string", "description": "", "x-enumNames": [ "Unknown", "MachineCatalog", "VirtualMachine", "Site" ], "enum": [ "Unknown", "MachineCatalog", "VirtualMachine", "Site" ] }, "TaskType": { "title": "TaskType", "type": "string", "description": "", "x-enumNames": [ "Unknown", "TakeVmBackup", "RestoreVmBackup", "ResetOsDisk", "ResetIdDisk", "HardwareSchemeUpdate", "HardwareVmUpdate", "SiteBackup", "ImageUpdate" ], "enum": [ "Unknown", "TakeVmBackup", "RestoreVmBackup", "ResetOsDisk", "ResetIdDisk", "HardwareSchemeUpdate", "HardwareVmUpdate", "SiteBackup", "ImageUpdate" ] }, "TemplateRequestContract": { "title": "TemplateRequestContract", "type": "object", "description": "Template request", "additionalProperties": false, "properties": { "TemplateName": { "title": "String", "type": "string", "description": "Template name as identifier", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Template description", "nullable": true }, "Settings": { "title": "IEnumerable`1", "type": "array", "description": "Settings", "nullable": true, "items": { "$ref": "#/components/schemas/SettingRequestContract" } }, "ForceWrite": { "title": "Boolean", "type": "boolean", "description": "True to force this change to the database even if changes have been made by another user" } } }, "TemplateResponseContract": { "title": "TemplateResponseContract", "type": "object", "description": "Template", "additionalProperties": false, "properties": { "TemplateName": { "title": "String", "type": "string", "description": "Template name as identifier", "nullable": true }, "IsReadOnly": { "title": "Boolean", "type": "boolean", "description": "Is template builtin." }, "Description": { "title": "String", "type": "string", "description": "Template description", "nullable": true }, "Settings": { "title": "IEnumerable`1", "type": "array", "description": "Settings", "nullable": true, "items": { "$ref": "#/components/schemas/SettingResponseContract" } } } }, "TenancyType": { "title": "TenancyType", "type": "string", "description": "Indicates whether to use tenancy type Shared, Instance or Host when creating machines in Cloud Hypervisors.", "x-enumNames": [ "Unknown", "Shared", "Instance", "Host" ], "enum": [ "Unknown", "Shared", "Instance", "Host" ] }, "TenantDetailResponseModel": { "title": "TenantDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/TenantResponseModel" }, { "type": "object", "description": "Tenant detail object.", "additionalProperties": false } ] }, "TenantResponseModel": { "title": "TenantResponseModel", "type": "object", "description": "Tenant object.", "additionalProperties": false, "required": [ "Id", "Name" ], "properties": { "Id": { "title": "String", "type": "string", "description": "ID of the tenant.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the zone.", "minLength": 1 } } }, "TenantResponseModelCollection": { "title": "TenantResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfTenantResponseModel" }, { "type": "object", "description": "Response object for collections of items.", "additionalProperties": false } ] }, "TestComponentResultDetailModel": { "title": "TestComponentResultDetailModel", "type": "object", "description": "Represents one piece of test result explanatory data", "additionalProperties": false, "properties": { "ServiceSource": { "title": "String", "type": "string", "description": "The service source of any error information present in this record.\nTypically, this will be the service that ran the test. In some cases,\nparticularly where an orphaned object target was detected and the test could not\nbe run at all, the service source may be the framework itself, EnvTestService.", "nullable": true }, "Serverity": { "title": "String", "type": "string", "description": "The severity of the problem.", "nullable": true }, "Explanation": { "title": "String", "type": "string", "description": "The explanation of the problem.", "nullable": true }, "ExplanationParametersStr": { "title": "String", "type": "string", "description": "The details items of the problem.", "nullable": true }, "Action": { "title": "String", "type": "string", "description": "The action to be take to fix this problem.", "nullable": true } } }, "TestComponentResultModel": { "title": "TestComponentResultModel", "type": "object", "description": "A test component result is the result of running a test\nagainst a particular controller. If a test has EnvTestScope.Site,\nthe test result will have only one component. If a test has EnvTestScope.Controller,\nthe test will have as many component results as there are controllers in the site.", "additionalProperties": false, "properties": { "TestComponentTarget": { "title": "String", "type": "string", "description": "Gets or sets the test component target, usually the machine the test was run on.", "nullable": true }, "TestComponentStartTime": { "title": "String", "type": "string", "description": "Gets or sets the test component start time.\nIf the test has not yet been run, this may be null.", "nullable": true }, "FormattedTestComponentStartTime": { "title": "String", "type": "string", "description": "Gets or sets the formatted test component start time.\nIf the test has not yet been run, this may be null.\nRFC 3339 compatible format.", "nullable": true }, "TestComponentEndTime": { "title": "String", "type": "string", "description": "Gets or sets the test component end time.\nIf the test has not yet been run, this may be null.", "nullable": true }, "FormattedTestComponentEndTime": { "title": "String", "type": "string", "description": "Gets or sets the formatted test component end time.\nIf the test has not yet been run, this may be null.\nRFC 3339 compatible format.", "nullable": true }, "TestComponentStatus": { "description": "Gets or sets the test component status, representing the success or failure\nstate of the test run on this machine.", "$ref": "#/components/schemas/TestStatus" }, "ResultDetails": { "title": "TestComponentResultDetailModel[]", "type": "array", "description": "Gets or sets the result details, which is a list of\nadditional information about the state\nof a machine when a test succeeds, but has warnings,\nor fails. There may be more than one value for each severity, for example,\nmultiple warnings about the state of the License server.\nThe values must be localized.", "nullable": true, "items": { "$ref": "#/components/schemas/TestComponentResultDetailModel" } } } }, "TestReportResponseModel": { "title": "TestReportResponseModel", "type": "object", "description": "The test report object.", "additionalProperties": false, "properties": { "TestType": { "description": "The type of test report", "$ref": "#/components/schemas/TestType" }, "CreatedBy": { "title": "String", "type": "string", "description": "The owner of the test report", "nullable": true }, "ReportTime": { "title": "String", "type": "string", "description": "The time of the test report created", "nullable": true }, "FormattedReportTime": { "title": "String", "type": "string", "description": "The formatted time of the test report created\nRFC 3339 compatible format.", "nullable": true }, "TestResults": { "title": "TestReportResultModel[]", "type": "array", "description": "The test results", "nullable": true, "items": { "$ref": "#/components/schemas/TestReportResultModel" } } } }, "TestReportResultModel": { "title": "TestReportResultModel", "type": "object", "description": "The result of running a test. The result is composed of\na test id, scope and collection of 1 or more component results", "additionalProperties": false, "properties": { "TestName": { "title": "String", "type": "string", "description": "The localized display name of the test.", "nullable": true }, "TestDescription": { "title": "String", "type": "string", "description": "The description of the localized end user description of the test.", "nullable": true }, "TestStartTime": { "title": "String", "type": "string", "description": "Gets or sets the test start time.\nIf the test has not yet been run, this may be null.", "nullable": true }, "FormattedTestStartTime": { "title": "String", "type": "string", "description": "Gets or sets the formatted test start time.\nIf the test has not yet been run, this may be null.\nRFC 3339 compatible format.", "nullable": true }, "TestEndTime": { "title": "String", "type": "string", "description": "Gets or sets the test end time.\nIf the test has not yet been run, this may be null.", "nullable": true }, "FormattedTestEndTime": { "title": "String", "type": "string", "description": "Gets or sets the formatted test end time.\nIf the test has not yet been run, this may be null.\nRFC 3339 compatible format.", "nullable": true }, "TestServiceTarget": { "title": "String", "type": "string", "description": "Gets or sets the test service target, generally the name of the service the test is being run against.", "nullable": true }, "TestComponentStatus": { "title": "String", "type": "string", "description": "Gets or sets the overall status of this test run. If the test\nwas run against more than one controller, it is the result of\nor'ing together of the statuses of each component result.", "nullable": true }, "TestScope": { "description": "The target of a test: one controller (site wide test) or each controller", "$ref": "#/components/schemas/TestScope" }, "TestComponents": { "title": "TestComponentResultModel[]", "type": "array", "description": "Gets or sets the list of component results.\nEach machine that the test is run against will be represented by\na component result and their statuses aggregated into TestComponentStatus", "nullable": true, "items": { "$ref": "#/components/schemas/TestComponentResultModel" } } } }, "TestScope": { "title": "TestScope", "type": "string", "description": "Defines how a test must be run against a site.", "x-enumNames": [ "Site", "Controller", "Unknown" ], "enum": [ "Site", "Controller", "Unknown" ] }, "TestStatus": { "title": "TestStatus", "type": "string", "description": "The test status.", "x-enumNames": [ "Failed", "Warnings", "NotRun", "Successful", "Pending", "Unknown" ], "enum": [ "Failed", "Warnings", "NotRun", "Successful", "Pending", "Unknown" ] }, "TestType": { "title": "TestType", "type": "string", "description": "Defines test type.", "x-enumNames": [ "Site", "DeliveryGroup", "MachineCatalog", "ResourcePool", "Hypervisor", "Machine", "ServiceAccount", "Unknown" ], "enum": [ "Site", "DeliveryGroup", "MachineCatalog", "ResourcePool", "Hypervisor", "Machine", "ServiceAccount", "Unknown" ] }, "TimeSchemeDays": { "title": "TimeSchemeDays", "type": "string", "description": "Time scheme days.", "x-enumNames": [ "Unknown", "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Weekdays", "Weekend" ], "enum": [ "Unknown", "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Weekdays", "Weekend" ] }, "TimeZoneResponseModel": { "title": "TimeZoneResponseModel", "type": "object", "description": "Time zone response details.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Human-readable name of the time zone, including the UTC offset of\nthe standard (non-daylight-savings) time within the time zone. For\nexample, \"(UTC-10:00) Aleutian Islands\".\n\n\nThis is localized into the language requested by the caller.", "nullable": true }, "FullName": { "title": "String", "type": "string", "description": "Human-readable name of the time zone, including the UTC offset of\nthe standard (non-daylight-savings) time within the time zone. For\nexample, \"(UTC-10:00) Aleutian Islands\".\n\n\nThis is localized into the language requested by the caller.", "nullable": true }, "Primary": { "title": "String", "type": "string", "description": "IANA identifier of the time zone within the primary territory\ncovered by the time zone.\n\n\nThe and identifiers\nare usually, but not always, the same. For example, the primary\nentry for \"India Standard Time\" is \"Asia/Calcutta\" while the\ncanonical entry is \"Asia/Kolkata\".", "nullable": true }, "Canonical": { "title": "String", "type": "string", "description": "Canonical IANA identifier of the time zone.\n\n\nThe and identifiers\nare usually, but not always, the same. For example, the primary\nentry for \"India Standard Time\" is \"Asia/Calcutta\" while the\ncanonical entry is \"Asia/Kolkata\".", "nullable": true }, "WindowsId": { "title": "String", "type": "string", "description": "Windows identifier of the time zone.\n\n\nNote that although this may appear to be human-readable, it is\n**NOT** localized and therefore, should not be displayed in user\ninterfaces. Instead, use or\n properties for this purpose.", "nullable": true }, "UtcOffsetSeconds": { "title": "Int32", "type": "integer", "description": "UTC offset of the standard (non-daylight-savings) time within the\ntime zone.", "format": "int32" }, "UtcOffset": { "title": "String", "type": "string", "description": "String representation of UtcOffsetSeconds. Always\nstarts with `+` or `-`, followed by a two hours digits, `:`, and two\nminutes digits. (e.g. `-05:00` / `+00:00`)", "nullable": true }, "TzdbIds": { "title": "String[]", "type": "array", "description": "List of IANA identifiers which can be used to represent this time\nzone. May be non-exhaustive.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "TimeZoneResponseModelCollection": { "title": "TimeZoneResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfTimeZoneResponseModel" }, { "type": "object", "description": "TimeZone response collection", "additionalProperties": false } ] }, "UndismissTargetModel": { "title": "UndismissTargetModel", "type": "object", "description": "Represents a target to be un-dismissed, requiring only the Id.", "additionalProperties": false, "required": [ "Id" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Id of the target to un-dismiss.", "minLength": 1 } } }, "UnitPriceResponseModel": { "title": "UnitPriceResponseModel", "type": "object", "description": "The response object indicating the unit price.\nThe unit price refers to the cost per unit of a billing component.", "additionalProperties": false, "properties": { "Price": { "title": "Decimal", "type": "number", "description": "Gets or sets the price.", "format": "decimal", "nullable": true }, "UnitOfMeasure": { "title": "String", "type": "string", "description": "Gets or sets the unit of measure, such as per hour, per month, etc.", "nullable": true }, "Currency": { "title": "String", "type": "string", "description": "Gets or sets the currency, such as USD, EUR, etc.", "nullable": true } } }, "UpdateAdminAdministratorRequestModel": { "title": "UpdateAdminAdministratorRequestModel", "type": "object", "description": "Model for editing administrator.", "additionalProperties": false, "properties": { "Rights": { "title": "AdminRightRequestModel[]", "type": "array", "description": "Rights associated with the administrator.", "nullable": true, "items": { "$ref": "#/components/schemas/AdminRightRequestModel" } }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the administrator is enabled. Disabled\nadministrators cannot administer the site unless they are a member\nof a different user group which is granted access by a different\nadministrator record.", "nullable": true } } }, "UpdateAppVIsolationGroupRequestModel": { "title": "UpdateAppVIsolationGroupRequestModel", "type": "object", "description": "Request object for an App-V IsolationGroup.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Name of IsolationGroup", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Description of IsolationGroup", "nullable": true }, "IncludedAppVPackages": { "title": "AppVIsolationGroupPackageRequestModel[]", "type": "array", "description": "Included AppV packages", "nullable": true, "items": { "$ref": "#/components/schemas/AppVIsolationGroupPackageRequestModel" } } } }, "UpdateAppVServerRequestModel": { "title": "UpdateAppVServerRequestModel", "type": "object", "description": "Request model to update AppV server.", "additionalProperties": false, "properties": { "ManagementServer": { "title": "String", "type": "string", "description": "The url of the App-V Management server that packages will be discovered from.", "maxLength": 250, "nullable": true }, "PublishingServer": { "title": "String", "type": "string", "description": "The url of the App-V Publishing server that packages will be discovered from.", "maxLength": 250, "nullable": true } } }, "UpdateAutoscaleGroupPluginRequestModel": { "title": "UpdateAutoscaleGroupPluginRequestModel", "type": "object", "description": "Update an existing autoscale group plugin.\nThis is a polymorphic base class - use the appropriate subclass based on the plugin type.", "additionalProperties": false, "properties": { "Type": { "description": "Autoscale plugin type. Used for determining which subclass to deserialize to.\nIf not specified, defaults to Holiday type for backward compatibility.", "$ref": "#/components/schemas/AutoscalePluginType" }, "Name": { "title": "String", "type": "string", "description": "The name of the group plugin. Optional.", "maxLength": 64, "minLength": 1, "nullable": true }, "Priority": { "title": "Int32", "type": "integer", "description": "The priority of this group plugin with respect to other group plugins associated with the same desktop group.\nPriority 1 is the highest priority. Optional.", "format": "int32", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the group plugin is enabled. Optional.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "Optional description of the group plugin.", "nullable": true }, "AutoApprove": { "title": "Boolean", "type": "boolean", "description": "If True, indicates that any schedule override produced by the plugin is automatically accepted as the schedule for the target date. Otherwise the\nschedule is only accepted if the target date is on or before the date specified in ApprovedUtil. If AutoApprove is False and the ApprovedUtil date is\nnot set, or is in the past, then any schedule override produced is discarded without being used. Optional.", "nullable": true }, "ApprovedUntil": { "title": "String", "type": "string", "description": "If AutoApprove is False, specifies the date until which any schedule override produced by the plugin is automatically accepted as the schedule for\nthe target date. Optional.", "nullable": true }, "Dates": { "title": "String[]", "type": "array", "description": "Date range for the autoscale holiday plugin (yyyy-MM-dd format).\nIf not provided (null), the existing value is preserved.\nIf provided, must not be empty array.", "nullable": true, "items": { "title": "String", "type": "string" } }, "OverrideTimeSchemeUid": { "title": "Int32", "type": "integer", "description": "A power time scheme UID to use for holiday days.\n- Not provided (null): Keep existing value\n- -1: Clear this field (remove from configuration)\n- Positive value: Update to new value", "format": "int32", "nullable": true }, "PerformanceTarget": { "title": "Int32", "type": "integer", "description": "The performance target percentage for the Intelligent plugin.\nIf not provided (null), the existing value is preserved.\nValid range: 1-100.", "format": "int32", "maximum": 100.0, "minimum": 1.0, "nullable": true } } }, "UpdateAutoscalePluginTemplateRequestModel": { "title": "UpdateAutoscalePluginTemplateRequestModel", "type": "object", "description": "New autoscale plugin template request model", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "Autoscale plugin template name.", "maxLength": 64, "nullable": true }, "Dates": { "title": "String[]", "type": "array", "description": "Date range for the autoscale holiday plugin template.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "UpdateDismissTargetModel": { "title": "UpdateDismissTargetModel", "type": "object", "description": "Represents a target to update dismiss information, specifically the note.", "additionalProperties": false, "required": [ "Id" ], "properties": { "Id": { "title": "String", "type": "string", "description": "The Id of the target to update.", "minLength": 1 }, "Note": { "title": "String", "type": "string", "description": "The updated note for the dismiss target. Maximum length is 256 characters.\nIf null, the existing note will not be changed.", "maxLength": 256, "nullable": true } } }, "UpdateGeneralScheduleRequestModel": { "title": "UpdateGeneralScheduleRequestModel", "allOf": [ { "$ref": "#/components/schemas/UpdateScheduleRequestModel" }, { "type": "object", "additionalProperties": false } ] }, "UpdateGeneralTaskRequestModel": { "title": "UpdateGeneralTaskRequestModel", "allOf": [ { "$ref": "#/components/schemas/UpdateTaskRequestModel" }, { "type": "object", "additionalProperties": false } ] }, "UpdateHolidayAutoscaleGroupPluginRequestModel": { "title": "UpdateHolidayAutoscaleGroupPluginRequestModel", "allOf": [ { "$ref": "#/components/schemas/UpdateAutoscaleGroupPluginRequestModel" }, { "type": "object", "description": "Update an existing Holiday autoscale group plugin.", "additionalProperties": false, "properties": { "Dates": { "title": "String[]", "type": "array", "description": "Date range for the autoscale holiday plugin (yyyy-MM-dd format).\nIf not provided (null), the existing value is preserved.\nIf provided, must not be empty array.", "nullable": true, "items": { "title": "String", "type": "string" } }, "OverrideTimeSchemeUid": { "title": "Int32", "type": "integer", "description": "A power time scheme UID to use for holiday days.\n- Not provided (null): Keep existing value\n- -1: Clear this field (remove from configuration)\n- Positive value: Update to new value", "format": "int32", "nullable": true } } } ] }, "UpdateImageDefinitionRequestModel": { "title": "UpdateImageDefinitionRequestModel", "type": "object", "description": "Request object for updating image definition.", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "The name associated with the image definition.", "maxLength": 64, "pattern": "(.*)*", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The description associated with the image definition.", "maxLength": 512, "pattern": "(.*)*", "nullable": true }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the image definition should be a part of.\n\nThe \"All\" scope, and any tenant scopes, are implicit and cannot be\nremoved. To remove from all non-implicit scopes, specify an empty\narray ([]).", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenants to associate with the image definition.", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "UpdateImageVersionRequestModel": { "title": "UpdateImageVersionRequestModel", "type": "object", "description": "Request object for updating image version.", "additionalProperties": false, "properties": { "Description": { "title": "String", "type": "string", "description": "The description associated with the image version.", "maxLength": 512, "pattern": "(.*)*", "nullable": true } } }, "UpdateImageVersionResourcePoolsRequestModel": { "title": "UpdateImageVersionResourcePoolsRequestModel", "type": "object", "description": "Request object allowing caller to specify a list of\nresource pools to associate with an image version.", "additionalProperties": false, "properties": { "ResourcePools": { "title": "String[]", "type": "array", "description": "List of references to resource pools. This will be deprecated and replaced by ImageVersionResourcePools in future.", "nullable": true, "items": { "title": "String", "type": "string" } }, "ImageVersionResourcePools": { "title": "ImageVersionResourcePoolRequestModel[]", "type": "array", "description": "List of references to image version resource pools. This will replace ResourcePools.", "nullable": true, "items": { "$ref": "#/components/schemas/ImageVersionResourcePoolRequestModel" } } } }, "UpdateIntelligentAutoscaleGroupPluginRequestModel": { "title": "UpdateIntelligentAutoscaleGroupPluginRequestModel", "allOf": [ { "$ref": "#/components/schemas/UpdateAutoscaleGroupPluginRequestModel" }, { "type": "object", "description": "Update an existing Intelligent autoscale group plugin.", "additionalProperties": false, "properties": { "PerformanceTarget": { "title": "Int32", "type": "integer", "description": "The performance target percentage for the Intelligent plugin.\nIf not provided (null), the existing value is preserved.\nValid range: 1-100.", "format": "int32", "maximum": 100.0, "minimum": 1.0, "nullable": true } } } ] }, "UpdateLicensingAdminRequestModel": { "title": "UpdateLicensingAdminRequestModel", "type": "object", "description": "Request object for creation of licensing admin.", "additionalProperties": false, "properties": { "Permissions": { "description": "The permission of the licensing admin", "$ref": "#/components/schemas/LicensingPermissionLevel" } } }, "UpdateMachineAccountCreationRulesRequestModel": { "title": "UpdateMachineAccountCreationRulesRequestModel", "type": "object", "description": "Updates to machine account creation rules.", "additionalProperties": false, "properties": { "NamingScheme": { "title": "String", "type": "string", "description": "Defines the template name for AD accounts created in the identity pool.\n\n\nIf this is not specified, it will remain unchanged.\n\n\nIf the provisioning scheme is configured with a NamingScheme already,\nand this value is set to an empty string, the provisioning scheme will\nbe reconfigured so that it will no longer automatically create machine\naccounts.", "maxLength": 15, "pattern": "^^$|(?=^.{2,15}$)(?=^[^\\\\\\/:\\*\\?\"<>|,~!@$%^&'`=+;.(){}_\\s]*$)(?=^[^\\.])(?=^.*[^\\d].*$).*(?|,~!@$%^&'(){}_\\s]*$).*$", "nullable": true, "example": "For example, test.local" }, "NextValue": { "title": "String", "type": "string", "description": "Defines the next value that will be used if creating new AD accounts.\n\n\nIf not specified, will not be changed.\n\n\nCannot be specified if is set to an empty string.\n\n\nIf was not previously set, but is being set now, the default is a sequence of `0`s or `A`s,\ndepending on the .", "maxLength": 15, "pattern": "^\\w+$", "nullable": true, "example": "For example, 5" } } }, "UpdateMachineAccountRequestModel": { "title": "UpdateMachineAccountRequestModel", "type": "object", "description": "Update an Active directory machine account which was externally created.", "additionalProperties": false, "properties": { "ResetPassword": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the machine account password should be reset.", "nullable": true }, "Password": { "title": "String", "type": "string", "description": "The current password for the machine account, in the format specified by\nPasswordFormat.", "maxLength": 20480, "pattern": "(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\\$%\\^&\\*]).{8,}|^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$|(.*)*", "nullable": true, "example": "For example, password" }, "PasswordFormat": { "description": "The format of the machine account password.", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "ForceReset": { "title": "Boolean", "type": "boolean", "description": "Indicates whether accounts that are marked as 'in-use' can be reset or not.", "nullable": true } } }, "UpdateMachineCatalogProvisioningSchemeRequestModel": { "title": "UpdateMachineCatalogProvisioningSchemeRequestModel", "type": "object", "description": "Request object for updating the master image used for provisioned\nmachines in a machine catalog.", "additionalProperties": false, "properties": { "MasterImagePath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine snapshot\nor VM template that will be used. This identifies the hard disk\nto be used and the default values for the memory and processors.\nThis must be a path to a Snapshot or Template item in the\nresource pool to which the Machine Catalog is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, {vm name}.vm/{snapshot name}.snapshot" }, "MachineProfilePath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine template that will be used.\nThis identifies the VM template to be used and the default values for the tags,\nvirtual machine size, boot diagnostics, host cache property of OS disk,\naccelerated networking and availability zone.\nThis must be a path to a Virtual machine or Template item in the\nresource pool to which the Machine Catalog is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, XDHyp:\\path\\to\\VirtualMachine" }, "StoreOldImage": { "title": "Boolean", "type": "boolean", "description": "Whether the old image is stored in the catalog history.", "nullable": true }, "MinimumFunctionalLevel": { "description": "The functional level of the VDA installed on the new image.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "MasterImageNote": { "title": "String", "type": "string", "description": "The note of the new image.", "nullable": true }, "CpuCount": { "title": "Int32", "type": "integer", "description": "`DEPRECATED.` The number of processors that virtual machines created from the\nprovisioning scheme should use.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED.", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "`DEPRECATED.` The maximum amount of memory that virtual machines created from the\nprovisioning scheme should use.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "DEPRECATED.", "nullable": true }, "ServiceOfferingPath": { "title": "String", "type": "string", "description": "`DEPRECATED.` The hypervisor resource path of the Cloud service offering to use when creating machines.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED.", "nullable": true, "example": "For example, serviceOffering.folder/{offering name}.serviceOffering" }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the provisioning scheme that are specific to the\ntarget hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "CustomPropertiesInString": { "title": "String", "type": "string", "description": "The properties of the provisioning scheme in a single string, that are\nspecific to the target hosting infrastructure. This is an optional method\nto set the custom properties which are not in the form of an array.", "nullable": true }, "RebootOptions": { "description": "Reboot options for machines in the catalog.", "nullable": true, "$ref": "#/components/schemas/RebootMachinesRequestModel" }, "NumTotalMachines": { "title": "Int32", "type": "integer", "description": "`DEPRECATED.` Total number of machines desired within the catalog.\nOptional; default is to leave the number of machines in the catalog unchanged.", "format": "int32", "maximum": 2147483647.0, "minimum": 0.0, "deprecated": true, "x-deprecatedMessage": "DEPRECATED.", "nullable": true }, "MachineAccountCreationRules": { "description": "`DEPRECATED.` If specified, the machine account creation rules will be updated.\nIf not specified, the machine account creation rules will be left unchanged.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED.", "nullable": true, "$ref": "#/components/schemas/UpdateMachineAccountCreationRulesRequestModel" }, "AddAvailableMachineAccounts": { "title": "MachineAccountRequestModel[]", "type": "array", "description": "`DEPRECATED.` List of Active Directory machine accounts to add to the pool of available accounts that are to be used when machines are provisioned.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED.", "nullable": true, "items": { "$ref": "#/components/schemas/MachineAccountRequestModel" } }, "RemoveAvailableMachineAccounts": { "title": "String[]", "type": "array", "description": "`DEPRECATED.` List of Active Directory machine accounts to remove from the pool of available accounts that are used when machines are provisioned.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED.", "nullable": true, "example": [ "Name of an account to remove" ], "items": { "title": "String", "type": "string" } }, "MachineAccountDeleteOption": { "description": "`DEPRECATED.` Indicates how to treat machine accounts that are deleted from the provisioning scheme.", "deprecated": true, "x-deprecatedMessage": "DEPRECATED.", "nullable": true, "$ref": "#/components/schemas/MachineAccountDeleteOption" }, "AssignImageVersionToProvisioningScheme": { "description": "Image version assignment to this provisioning scheme.", "nullable": true, "$ref": "#/components/schemas/AssignImageVersionToProvisioningSchemeRequestModel" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of provisioning scheme. Set the value of the NameValueStringPairModel is null or empty will be remove this metadata.\nNot existing Name and Value NameValueStringPairModel object will be added.\nThe same Name but different value object will be updated.\nIf Metadata is specified, note that other properties in request will be ignored. So MasterImagePath and\nAssignImageVersionToProvisioningScheme only can be null or empty, to avoid unintented update.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "UpdateMachineCatalogPvsSchemeRequestModel": { "title": "UpdateMachineCatalogPvsSchemeRequestModel", "type": "object", "description": "Request model for updating the PVS scheme of a machine catalog.", "additionalProperties": false, "properties": { "VDiskUid": { "title": "Guid", "type": "string", "description": "vDisk UID to use.", "format": "guid", "nullable": true }, "UpdateBdm": { "title": "Boolean", "type": "boolean", "description": "Update the BDM (Boot Device Manager) file", "nullable": true }, "MinimumFunctionalLevel": { "description": "The functional level of the VDA installed on the new image.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "RebootOptions": { "description": "Reboot options for machines in the catalog.", "nullable": true, "$ref": "#/components/schemas/RebootMachinesRequestModel" } } }, "UpdateMachineCatalogRequestModel": { "title": "UpdateMachineCatalogRequestModel", "type": "object", "description": "Request object for updating machine catalogs.", "additionalProperties": false, "properties": { "AdminFolder": { "title": "String", "type": "string", "description": "The folder in which the machine catalog resides.\nIf not specified, the value will not be changed.\nMay be specified as either the folder\nId or\nPath.\nIf specified as a path, and the path does not exist, it will be automatically\ncreated.", "nullable": true, "example": "Path or Id of the admin folder" }, "Name": { "title": "String", "type": "string", "description": "Name of the machine catalog. Each machine catalog within a site must have a unique name.\n\nIf not specified, will not be changed.", "maxLength": 64, "pattern": "(.*)*", "nullable": true, "example": "For example, c7b0d0a7-b53b-42e1-8f69-accebb407e2b" }, "Description": { "title": "String", "type": "string", "description": "Description of the machine catalog.\n\nIf not specified, will not be changed.", "maxLength": 512, "pattern": "(.*)*", "nullable": true, "example": "Description of the machine catalog" }, "HypervisorConnection": { "title": "String", "type": "string", "description": "Specifies the hypervisor connection to use for power management of machines in this\nmachine catalog.\n\nIf not specified, will not be changed.", "nullable": true, "example": "Name of the hypervisor connection" }, "RemotePCEnrollmentScopes": { "title": "RemotePCEnrollmentScopeRequestModel[]", "type": "array", "description": "List of one or more remote PC enrollment scopes.\n\nIf not specified, will not be changed.\nIf specified, *all* enrollment scopes must be listed. Existing enrollment scopes that are\nnot listed will be removed.\n\n\nRemoving an enrollment scope will *not* remove existing remote PCs that were enrolled via\nthat scope.", "nullable": true, "items": { "$ref": "#/components/schemas/RemotePCEnrollmentScopeRequestModel" } }, "MinimumFunctionalLevel": { "description": "The minimum functional level of machines in the machine catalog.\n\nIf not specified, will not be changed.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "PvsAddress": { "title": "String", "type": "string", "description": "IP address of the PVS server to be used.\n\nCan only be specified if is\n.\nIf not specified, will not be changed.", "maxLength": 255, "pattern": "UNKNOWN", "nullable": true, "example": "For example, 1.1.1.1" }, "PvsDomain": { "title": "String", "type": "string", "description": "The domain of the PVS server to be used.\n\nCan only be specified if is\n.\nIf not specified, will not be changed.", "maxLength": 255, "pattern": "UNKNOWN", "nullable": true, "example": "For example, PVS.local" }, "Scopes": { "title": "String[]", "type": "array", "description": "Administrative scopes which the machine catalog should be a part of.\n\nThe \"All\" scope, and any tenant scopes, are implicit and cannot be\nremoved. To remove from all non-implicit scopes, specify an empty\narray ([]).\n\n\nSpecifying tenant scopes is equivalent to specifying the\n property and is subject to the same\nconstraints.", "nullable": true, "example": [ "For example", " All" ], "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenants to associate with the machine catalog.", "nullable": true, "example": [ "Name of a tenant" ], "items": { "title": "String", "type": "string" } }, "ShowRdsLicenseWarning": { "title": "Boolean", "type": "boolean", "description": "Indicate whether the RDS license warning should appear for the machine catalog.", "nullable": true }, "Zone": { "title": "String", "type": "string", "description": "Zone the machine catalog is associated with.\n\nIf not specified, will not be changed.", "nullable": true, "example": "Name or Id of a zone" }, "CpuCount": { "title": "Int32", "type": "integer", "description": "The number of processors that virtual machines created from the\nprovisioning scheme should use.", "format": "int32", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "The maximum amount of memory that virtual machines created from the\nprovisioning scheme should use.", "format": "int32", "nullable": true }, "ServiceOfferingPath": { "title": "String", "type": "string", "description": "The hypervisor resource path of the Cloud service offering to use when creating machines.", "nullable": true, "example": "For example, serviceOffering.folder/{offering name}.serviceOffering" }, "SecurityGroups": { "title": "String[]", "type": "array", "description": "The hypervisor resource path(s) of the Cloud security group(s) to use when creating machines.", "nullable": true, "example": [ "For example", " securityGroup.folder/{{security group name}}.securityGroup" ], "items": { "title": "String", "type": "string" } }, "NetworkMapping": { "title": "NetworkMapRequestModel[]", "type": "array", "description": "Specifies how the attached NICs are mapped to networks.\nIf this parameter is omitted, the current NICs setting is not updated.\nIf an empty array is specified, new VMs will be created with a single NIC, which\nis mapped to the default network in the hosting unit.\nIf an non-empty array is supplied, the NICs setting is updated, and new machines\nwill be created with the number of NICs specified in the array, with each NIC\nattached to the specified network.", "nullable": true, "items": { "$ref": "#/components/schemas/NetworkMapRequestModel" } }, "VdaUpgradeType": { "description": "VDA upgrade type of this machine catalog.\nIf not specified, the upgrade type will not be changed.", "nullable": true, "$ref": "#/components/schemas/VdaUpgradeType" }, "MachineProfilePath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine template that will be used.\nThis identifies the VM template to be used and the default values for the tags,\nvirtual machine size, boot diagnostics, host cache property of OS disk,\naccelerated networking and availability zone.\nThis must be a path to a Virtual machine or Template item in the\nresource pool to which the Machine Catalog is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, XDHyp:\\path\\to\\VirtualMachine" }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the provisioning scheme that are specific to the\ntarget hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of machine catalog. Set the value of the NameValueStringPairModel is null or empty will be remove this metadata.\nNot existing Name and Value NameValueStringPairModel object will be added.\nThe same Name but different value object will be updated.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "WriteBackCacheDiskSizeGB": { "title": "Int32", "type": "integer", "description": "The size in GB of any temporary storage disk used by the write back cache.\nShould be used in conjunction with WriteBackCacheMemorySizeMB.", "format": "int32", "nullable": true }, "WriteBackCacheMemorySizeMB": { "title": "Int32", "type": "integer", "description": "The size in MB of any write back cache if required.\nShould be used in conjunction with WriteBackCacheDiskSizeGB.", "format": "int32", "nullable": true }, "AzureADSecurityGroupName": { "title": "String", "type": "string", "description": "Name of Microsoft Entra ID security group to be created.", "nullable": true }, "AzureADTenantId": { "title": "Guid", "type": "string", "description": "TenantId of Azure Directory.", "format": "guid", "nullable": true }, "ServiceAccountUid": { "title": "String[]", "type": "array", "description": "Indicates whether to associate service accounts to the IdentityPool.", "nullable": true, "items": { "title": "String", "type": "string" } }, "HypervisorVMTagging": { "title": "Boolean", "type": "boolean", "description": "Indicates that assigned VMs from this catalog will carry a hypervisor-level tag.", "nullable": true }, "EntraIDExtensionAttributes": { "title": "Dictionary`2", "type": "object", "description": "The value to set extension attributes of Microsoft Entra ID device of Microsoft Entra joined machines.", "nullable": true, "additionalProperties": { "title": "String", "type": "string" } } } }, "UpdateMachineConfigurationRequestModel": { "title": "UpdateMachineConfigurationRequestModel", "type": "object", "additionalProperties": false, "properties": { "Name": { "title": "String", "type": "string", "description": "New name for machine configuration.\nThis may have the form \"ConfigurationSlotName\\MachineConfigurationName\" or \"MachineConfigurationName\".\nIf the \"ConfigurationSlotName\" is provided it must match the name of the configuration slot that the machine configuration is associated with.", "maxLength": 64, "nullable": true, "example": "SecureBrowserGPO" }, "Policy": { "title": "String", "type": "string", "description": "New binary array of encoded settings data.\nPolicy settings data created with the SDK snap-in that matches the SettingsGroup of the configuration slot.\nBase64 encrypted.", "nullable": true }, "Description": { "title": "String", "type": "string", "description": "New description for the machine configuration.\t", "maxLength": 512, "nullable": true } } }, "UpdateMachineRequestModel": { "title": "UpdateMachineRequestModel", "type": "object", "description": "Update a machine.", "additionalProperties": false, "properties": { "AssignedClientName": { "title": "String", "type": "string", "description": "The client name to which this machine will be assigned. Machines can be assigned to\nmultiple users, a single client IP address, or a single client name, but only to one\nof these categories at a time.", "nullable": true, "example": "Name of an assigned client" }, "AssignedIPAddress": { "title": "String", "type": "string", "description": "The client IP address to which this machine will be assigned. Machines can be assigned\nto multiple users, a single client IP address, or a single client name, but only to\none of these categories at a time.", "nullable": true, "example": "For example, 1.1.1.1" }, "AssignedUsers": { "title": "String[]", "type": "array", "description": "The user(s) to whom this machine will be assigned. Machines can be assigned\nto multiple users, a single client IP address, or a single client name, but only to\none of these categories at a time.", "nullable": true, "example": [ "For example", " test.local\\admin" ], "items": { "title": "String", "type": "string" } }, "HostedMachineId": { "title": "String", "type": "string", "description": "The unique ID by which the hypervisor recognizes the machine.\nOmit this for machines that are not power-managed.", "nullable": true, "example": "Id of a hosted machine" }, "HypervisorConnection": { "title": "String", "type": "string", "description": "Hypervisor connection to use for power management of the machine.", "nullable": true, "example": "Name of a hypervisor connection" }, "InMaintenanceMode": { "title": "Boolean", "type": "boolean", "description": "Specifies whether the machine is initially in maintenance mode. A machine in maintenance mode is\nnot available for new sessions, and for managed machines all automatic power management is disabled.\nIf `null`, will not be changed.", "nullable": true }, "PublishedName": { "title": "String", "type": "string", "description": "Customized name of the machine that is displayed in StoreFront, if the machine has been published.\nIt can be set only for private desktops.\nIf `null`, will not be changed.\nIf empty string (`\"\"`), the machine will be unassigned from any published name.", "nullable": true }, "Icon": { "title": "String", "type": "string", "description": "Specifies the image data of the icon used to display the published\ndesktop to the user, and of assigned desktop(s) in the case\nwhere SharingKind\nis equal to Private.", "nullable": true, "example": "Data of the icon" }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of machine. Set the value of the NameValueStringPairModel is null or empty will remove this metadata.\nNot existing Name and Value NameValueStringPairModel object will be added.\nThe same Name but different value object will be updated.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "UpdateMaintenanceCycleTaskRequestModel": { "title": "UpdateMaintenanceCycleTaskRequestModel", "allOf": [ { "$ref": "#/components/schemas/UpdateTaskRequestModel" }, { "type": "object", "description": "Update task details for Maintenance Cycle tasks.", "additionalProperties": false, "properties": { "Description": { "title": "String", "type": "string", "description": "The description of the Maintenance Cycle.", "maxLength": 512, "nullable": true }, "ScheduledStartTime": { "title": "String", "type": "string", "description": "Maintenance cycle start time.\nRFC 3339 compatible format.", "nullable": true }, "MaxDurationInMinutes": { "title": "Int32", "type": "integer", "description": "The max duration allowed for maintenance cycle.", "format": "int32", "nullable": true }, "PurgeDBAfterInDays": { "title": "Int32", "type": "integer", "description": "Purge history data after a certain number of days.", "format": "int32", "nullable": true }, "SessionWarningLogOffTitle": { "title": "String", "type": "string", "description": "The title of session log off warning. ", "maxLength": 512, "nullable": true }, "SessionWarningLogOffMessage": { "title": "String", "type": "string", "description": "The message of session log off warning.", "maxLength": 512, "nullable": true }, "SessionWarningTimeInMinutes": { "title": "Int32", "type": "integer", "description": "The countdown duration for session log off. ", "format": "int32", "nullable": true } } } ] }, "UpdateProvisionedBackupRequestModel": { "title": "UpdateProvisionedBackupRequestModel", "type": "object", "description": "Request object for updating provisioned backups.", "additionalProperties": false, "properties": { "Description": { "title": "String", "type": "string", "description": "Description of the Provisioned Backup.", "maxLength": 512, "pattern": "(.*)*", "nullable": true } } }, "UpdateProvisionedVirtualMachineRequestModel": { "title": "UpdateProvisionedVirtualMachineRequestModel", "type": "object", "description": "Request model for updating a provisioned virtual machine.", "additionalProperties": false, "properties": { "CpuCount": { "title": "Int32", "type": "integer", "description": "The number of processors. Not supported for cloud hypervisors", "format": "int32", "nullable": true }, "MemoryMB": { "title": "Int32", "type": "integer", "description": "The maximum amount of memory in megabytes. Not supported for cloud hypervisors", "format": "int32", "nullable": true }, "ServiceOfferingPath": { "title": "String", "type": "string", "description": "The hypervisor resource path of the Cloud service offering to use when creating machines.", "nullable": true }, "MachineProfilePath": { "title": "String", "type": "string", "description": "The path in the resource pool to the virtual machine template that will be used.\nThis identifies the VM template to be used and the default values for the tags,\nvirtual machine size, boot diagnostics, host cache property of OS disk,\naccelerated networking and availability zone.\nThis must be a path to a Virtual machine or Template item in the\nresource pool to which the Machine Catalog is associated.", "maxLength": 2147483647, "pattern": "(?i)XDHyp:(\\\\{1,2}|\\/{1,2})Connections(\\\\{1,2}|\\/{1,2}).*|(?i)XDHyp:(\\\\{1,2}|\\/{1,2})HostingUnits(\\\\{1,2}|\\/{1,2}).*|(?i)hypervisors(\\\\{1,2}|\\/{1,2}).*|^[^;:#\\*\\?=<>\\|\\[\\]\\(\\)\"'\\{\\}`]*.*", "nullable": true, "example": "For example, XDHyp:\\path\\to\\VirtualMachine" }, "CustomProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The properties of the provisioning scheme that are specific to the\ntarget hosting infrastructure.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "RevertToProvSchemeConfiguration": { "title": "Boolean", "type": "boolean", "description": "If supplied, all existing configuration is cleared for the given machine.\nIt is mutually exclusive with parameters that apply configuration settings", "nullable": true } } }, "UpdateScheduleRequestModel": { "title": "UpdateScheduleRequestModel", "type": "object", "description": "Update schedule details.", "additionalProperties": false, "required": [ "Type" ], "properties": { "Type": { "description": "Type of Schedule. Required", "$ref": "#/components/schemas/TaskType" } } }, "UpdateServiceAccountCapabilityPreviewRequestModel": { "title": "UpdateServiceAccountCapabilityPreviewRequestModel", "type": "object", "description": "Request model for updating service account capability preview", "additionalProperties": false, "properties": { "Capabilities": { "title": "String[]", "type": "array", "description": "Gets or sets capabilities for the service account", "nullable": true, "items": { "title": "String", "type": "string" } } } }, "UpdateServiceAccountCapabilityPreviewResponseModel": { "title": "UpdateServiceAccountCapabilityPreviewResponseModel", "type": "object", "description": "Represents the response model for updating service account capability preview.", "additionalProperties": false, "properties": { "ImpactedCatalogs": { "title": "Dictionary`2", "type": "object", "description": "Gets or sets the impacted catalogs.", "nullable": true, "additionalProperties": { "title": "Int32", "type": "integer", "format": "int32" } } } }, "UpdateServiceAccountRequestModel": { "title": "UpdateServiceAccountRequestModel", "type": "object", "description": "Request model for updating a service account.", "additionalProperties": false, "properties": { "AccountId": { "title": "String", "type": "string", "description": "The identifier for the service account", "nullable": true, "example": "Domain user like \"cvad\\\\joe\" if 'IdentityProviderType' is ActiveDirectory\"" }, "AccountSecret": { "title": "String", "type": "string", "description": "The secret for the service account. E.g. Azure application (client) secret if 'IdentityProviderType' is AzureAD.\nThe secret will be encrypted and stored in database.", "nullable": true }, "AccountSecretFormat": { "description": "Format of the AccountSecret. Default is\nPlainText.", "default": "PlainText", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "SecretExpiryTime": { "title": "String", "type": "string", "description": "The secret expiration time for the service account", "nullable": true }, "Capabilities": { "title": "String[]", "type": "array", "description": "The capabilities for the service account", "nullable": true, "items": { "title": "String", "type": "string" } }, "DisplayName": { "title": "String", "type": "string", "description": "The display name", "maxLength": 128, "nullable": true }, "Description": { "title": "String", "type": "string", "description": "The description", "nullable": true }, "Scopes": { "title": "String[]", "type": "array", "description": "The scopes for the service account.", "nullable": true, "items": { "title": "String", "type": "string" } }, "Tenants": { "title": "String[]", "type": "array", "description": "Tenants to associate with the service account.", "nullable": true, "items": { "title": "String", "type": "string" } }, "CustomProperties": { "title": "String", "type": "string", "description": "The custom properties\nFormat is the following: \"CustomProperties\":\"[{\\\"Name\\\":\\\"ProxyHypervisorTrafficThroughConnector\\\",\\\"Value\\\":\\\"true\\\"},{\\\"Name\\\":\\\"ZoneUid\\\",\\\"Value\\\":\\\"4e1d7040-d830-4d97-8f94-342c03846f19\\\"}]\". ", "nullable": true }, "UserPrincipalName": { "title": "String", "type": "string", "description": "The Microsoft Entra ID user principal name.", "nullable": true }, "UserSecret": { "title": "String", "type": "string", "description": "The Microsoft Entra ID user secret.", "nullable": true }, "UserSecretFormat": { "description": "Format of the UserSecret. Default is\nPlainText.", "default": "PlainText", "nullable": true, "$ref": "#/components/schemas/IdentityPasswordFormat" }, "UserSecretExpiryTime": { "title": "String", "type": "string", "description": "The Microsoft Entra ID user secret expiration time for the service account.\nIf it is not specified, will set secret as never expires.", "nullable": true }, "AccessTokenForBulk": { "title": "String", "type": "string", "description": "Get or set access token for Bulk token", "nullable": true }, "BulkTokenExpiryTime": { "title": "Int32", "type": "integer", "description": "Bulk token expiry time (in days, range: 30–180)", "format": "int32", "nullable": true } } }, "UpdateSiteBackupScheduleRequestModel": { "title": "UpdateSiteBackupScheduleRequestModel", "allOf": [ { "$ref": "#/components/schemas/UpdateScheduleRequestModel" }, { "type": "object", "additionalProperties": false, "required": [ "Name" ], "properties": { "Name": { "title": "String", "type": "string", "description": "Name", "minLength": 1 }, "Day": { "description": "Day", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "DaysInWeek": { "title": "BackupRestoreScheduleDays[]", "type": "array", "description": "Days in Week", "nullable": true, "items": { "$ref": "#/components/schemas/BackupRestoreScheduleDays" } }, "DayInMonth": { "description": "Days in Month", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleDays" }, "WeekInMonth": { "description": "Weeks in Month", "nullable": true, "$ref": "#/components/schemas/BackupRestoreScheduleWeeks" }, "StartDate": { "title": "String", "type": "string", "description": "Start Date", "nullable": true }, "FrequencyFactor": { "title": "Int32", "type": "integer", "description": "Frequency Factor", "format": "int32" }, "Description": { "title": "String", "type": "string", "description": "Description", "nullable": true }, "Enabled": { "title": "Boolean", "type": "boolean", "description": "Enabled\n " }, "Frequency": { "description": "Frequency\n ", "$ref": "#/components/schemas/BackupRestoreScheduleFrequency" }, "StartTime": { "title": "String", "type": "string", "description": "Start Time", "nullable": true }, "TimeZoneId": { "title": "String", "type": "string", "description": "Time Zone Id", "nullable": true } } } ] }, "UpdateSiteBackupTaskRequestModel": { "title": "UpdateSiteBackupTaskRequestModel", "allOf": [ { "$ref": "#/components/schemas/UpdateTaskRequestModel" }, { "type": "object", "additionalProperties": false, "properties": { "Description": { "title": "String", "type": "string", "description": "The description of the site backup to update.", "nullable": true } } } ] }, "UpdateTaskRequestModel": { "title": "UpdateTaskRequestModel", "type": "object", "description": "Update task details.", "additionalProperties": false, "required": [ "Type" ], "properties": { "Type": { "description": "Type of task. Required", "$ref": "#/components/schemas/TaskType" }, "Description": { "title": "String", "type": "string", "description": "The description of the Maintenance Cycle.", "maxLength": 512, "nullable": true }, "ScheduledStartTime": { "title": "String", "type": "string", "description": "Maintenance cycle start time.\nRFC 3339 compatible format.", "nullable": true }, "MaxDurationInMinutes": { "title": "Int32", "type": "integer", "description": "The max duration allowed for maintenance cycle.", "format": "int32", "nullable": true }, "PurgeDBAfterInDays": { "title": "Int32", "type": "integer", "description": "Purge history data after a certain number of days.", "format": "int32", "nullable": true }, "SessionWarningLogOffTitle": { "title": "String", "type": "string", "description": "The title of session log off warning. ", "maxLength": 512, "nullable": true }, "SessionWarningLogOffMessage": { "title": "String", "type": "string", "description": "The message of session log off warning.", "maxLength": 512, "nullable": true }, "SessionWarningTimeInMinutes": { "title": "Int32", "type": "integer", "description": "The countdown duration for session log off. ", "format": "int32", "nullable": true } } }, "UpdateUpgradeScheduleRequestModel": { "title": "UpdateUpgradeScheduleRequestModel", "type": "object", "description": "Request object for updating existing VDA upgrade schedule(s) on a\nmachine catalog or machine object. The upgrade schedule must be\nin UpgradeScheduled state.", "additionalProperties": false, "required": [ "StartDateTimeUtc", "DurationInHours" ], "properties": { "StartDateTimeUtc": { "title": "DateTime", "type": "string", "description": "UTC time to start the Vda upgrade. Must be a future time.", "format": "date-time", "minLength": 1 }, "DurationInHours": { "title": "Int32", "type": "integer", "description": "Timeout duration in hours. Valid range is 1 to 24.", "format": "int32" } } }, "UpgradePackageVersionResponseModel": { "title": "UpgradePackageVersionResponseModel", "type": "object", "description": "Response object for a VDA upgrade package version.", "additionalProperties": false, "required": [ "UpgradeType", "UpgradePackageVersion" ], "properties": { "UpgradeType": { "description": "Upgrade type for this record.\nShould be either LTSR or CR.", "$ref": "#/components/schemas/VdaUpgradeType" }, "UpgradePackageVersion": { "title": "String", "type": "string", "description": "Latest released package version for the upgrade type.", "minLength": 1 } } }, "UpgradePackageVersionResponseModelCollection": { "title": "UpgradePackageVersionResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfUpgradePackageVersionResponseModel" }, { "type": "object", "description": "VDA upgrade package version model response collection", "additionalProperties": false } ] }, "UserManagementModel": { "title": "UserManagementModel", "type": "string", "description": "User management model to use for a delivery group.", "x-enumNames": [ "Unknown", "CloudLibrary", "Studio" ], "enum": [ "Unknown", "CloudLibrary", "Studio" ] }, "UserTokenRequestModel": { "title": "UserTokenRequestModel", "type": "object", "description": "Request object for user token.", "additionalProperties": false, "required": [ "SessionKey", "Sid", "VdaIPAddress", "BrokeringTime" ], "properties": { "SessionKey": { "title": "Guid", "type": "string", "description": "The session key.", "format": "guid", "minLength": 1 }, "Sid": { "title": "String", "type": "string", "description": "The users SID.", "minLength": 1 }, "VdaIPAddress": { "title": "String", "type": "string", "description": "The IP address of the VDA.", "minLength": 1 }, "BrokeringTime": { "title": "DateTime", "type": "string", "description": "The time at which the session is brokered.", "format": "date-time", "minLength": 1 } } }, "UserTokenResponseModel": { "title": "UserTokenResponseModel", "type": "object", "description": "Response object for a user token.", "additionalProperties": false, "properties": { "UserToken": { "title": "String", "type": "string", "description": "A signed user token.", "nullable": true } } }, "UserZonePreferenceResponseModel": { "title": "UserZonePreferenceResponseModel", "type": "object", "description": "Data model for user zone preference.", "additionalProperties": false, "properties": { "FullName": { "title": "String", "type": "string", "description": "The full name of the user or user group.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the user or user group.", "nullable": true }, "Sid": { "title": "String", "type": "string", "description": "Sid of the user or user group.", "nullable": true }, "Upn": { "title": "String", "type": "string", "description": "UPN of the user or user group.", "nullable": true }, "Zone": { "description": "Zone.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" } } }, "UserZonePreferenceResponseModelCollection": { "title": "UserZonePreferenceResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfUserZonePreferenceResponseModel" }, { "type": "object", "description": "Collection of UserZonePreferenceResponseModel", "additionalProperties": false } ] }, "VDAComponentModel": { "title": "VDAComponentModel", "type": "object", "description": "Model of VDA component.", "additionalProperties": false, "properties": { "ComponentId": { "title": "String", "type": "string", "description": "Id of this component object.", "nullable": true }, "ComponentName": { "title": "String", "type": "string", "description": "Name of this component object.", "nullable": true }, "ComponentDescription": { "title": "String", "type": "string", "description": "Description of this component object.", "nullable": true }, "Parameters": { "title": "VDAComponentParameterModel[]", "type": "array", "description": "Parameters of this component object.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAComponentParameterModel" } } } }, "VDAComponentParameterModel": { "title": "VDAComponentParameterModel", "type": "object", "description": "Model of VDA component's parameter.", "additionalProperties": false, "properties": { "ParameterName": { "title": "String", "type": "string", "description": "Name of this parameter object.", "nullable": true }, "ParameterId": { "title": "String", "type": "string", "description": "Id of this parameter object.", "nullable": true }, "ParameterDescription": { "title": "String", "type": "string", "description": "Description of this parameter object.", "nullable": true }, "ParameterType": { "title": "String", "type": "string", "description": "Type of this parameter object.", "nullable": true } } }, "VDAComponentParameterRequestModel": { "title": "VDAComponentParameterRequestModel", "type": "object", "additionalProperties": false, "required": [ "ParameterId" ], "properties": { "ParameterId": { "title": "Guid", "type": "string", "description": "Id of the parameter.", "format": "guid", "minLength": 1 }, "ParameterValue": { "title": "String", "type": "string", "description": "Value of the parameter.", "nullable": true } } }, "VDAComponentRequestModel": { "title": "VDAComponentRequestModel", "type": "object", "additionalProperties": false, "required": [ "ComponentId" ], "properties": { "ComponentId": { "title": "Guid", "type": "string", "description": "Id of the component.", "format": "guid", "minLength": 1 }, "Parameters": { "title": "VDAComponentParameterRequestModel[]", "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/VDAComponentParameterRequestModel" } } } }, "VDAComponentsAndFeaturesResponseModel": { "title": "VDAComponentsAndFeaturesResponseModel", "type": "object", "description": "Response model of components and features related to the VDA.", "additionalProperties": false, "properties": { "InstalledComponents": { "title": "VDAComponentModel[]", "type": "array", "description": "Installed VDA components of the catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAComponentModel" } }, "AvailableComponents": { "title": "VDAComponentModel[]", "type": "array", "description": "Available VDA components of the catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAComponentModel" } }, "AvailableFeatures": { "title": "VDAFeatureModel[]", "type": "array", "description": "Available VDA features of the catalog.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAFeatureModel" } } } }, "VDAComponentsSelectionValidationRequestModel": { "title": "VDAComponentsSelectionValidationRequestModel", "type": "object", "description": "Selection of VDA upgrade components and features related to the Machine Catalog.", "additionalProperties": false, "properties": { "IncludedAdditionalComponents": { "title": "VDAComponentRequestModel[]", "type": "array", "description": "New Components that are to be included/added in this catalog level VDA Upgrade schedule.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAComponentRequestModel" } }, "ExcludedComponents": { "title": "VDAComponentRequestModel[]", "type": "array", "description": "Installed Components that are to be excluded/omitted in this catalog level VDA Upgrade schedule.", "nullable": true, "items": { "$ref": "#/components/schemas/VDAComponentRequestModel" } }, "Features": { "title": "String[]", "type": "array", "description": "Features that needs to enabled on this catalog level VDA Upgrade schedule.", "nullable": true, "items": { "title": "String", "type": "string" } }, "UpgradeVersion": { "title": "String", "type": "string", "description": "Version of the VDA to be upgraded to.", "nullable": true } } }, "VDAComponentsSelectionValidationResponseModel": { "title": "VDAComponentsSelectionValidationResponseModel", "type": "object", "description": "The validation response model for VDA components selection of a catalog/ a machine/ machines.", "additionalProperties": false, "properties": { "Uid": { "title": "Int32", "type": "integer", "description": "Uid of the object.", "format": "int32" }, "Id": { "title": "String", "type": "string", "description": "Id of the object.", "nullable": true }, "Name": { "title": "String", "type": "string", "description": "Name of the object.", "nullable": true }, "IsValid": { "title": "Boolean", "type": "boolean", "description": "Validation result of VDA components selection." }, "Message": { "title": "String", "type": "string", "description": "Validation message of VDA components selection.", "nullable": true } } }, "VDAFeatureModel": { "title": "VDAFeatureModel", "type": "object", "description": "Model of VDA feature.", "additionalProperties": false, "properties": { "FeatureId": { "title": "String", "type": "string", "description": "Id of this feature object.", "nullable": true }, "FeatureName": { "title": "String", "type": "string", "description": "Name of this feature object.", "nullable": true }, "FeatureDescription": { "title": "String", "type": "string", "description": "Description of this feature object.", "nullable": true } } }, "VdaUpgradeMachineScheduleStatus": { "title": "VdaUpgradeMachineScheduleStatus", "type": "string", "description": "VDA package upgrade schedule status.", "x-enumNames": [ "Unknown", "UpgradeScheduled", "UpgradeInUpgradeWindow", "UpgradeInProgress", "UpgradeCancelled", "UpgradeFailed", "UpgradeSuccess", "UpgradeValidationFailed" ], "enum": [ "Unknown", "UpgradeScheduled", "UpgradeInUpgradeWindow", "UpgradeInProgress", "UpgradeCancelled", "UpgradeFailed", "UpgradeSuccess", "UpgradeValidationFailed" ] }, "VdaUpgradeScheduleStatus": { "title": "VdaUpgradeScheduleStatus", "type": "string", "description": "VDA package upgrade schedule status.", "x-enumNames": [ "NotScheduled", "UpgradeScheduled", "UpgradeInProgress", "UpgradeCancelled", "UpgradeFailed", "UpgradeSuccessful" ], "enum": [ "NotScheduled", "UpgradeScheduled", "UpgradeInProgress", "UpgradeCancelled", "UpgradeFailed", "UpgradeSuccessful" ] }, "VdaUpgradeState": { "title": "VdaUpgradeState", "type": "string", "description": "Machine catalog or machine state for VDA package upgrade actions.", "x-enumNames": [ "MissingUpgradeType", "UpgradeScheduled", "UpgradeAvailable", "UpToDate", "Unknown" ], "enum": [ "MissingUpgradeType", "UpgradeScheduled", "UpgradeAvailable", "UpToDate", "Unknown" ] }, "VdaUpgradeType": { "title": "VdaUpgradeType", "type": "string", "description": "VDA upgrade types\n ", "x-enumNames": [ "NotSet", "LTSR", "CR", "EAR_LTSR", "EAR_CR" ], "enum": [ "NotSet", "LTSR", "CR", "EAR_LTSR", "EAR_CR" ] }, "VdaVersionContract": { "title": "VdaVersionContract", "type": "object", "description": "VDA version information.", "additionalProperties": false, "properties": { "Product": { "title": "String", "type": "string", "description": "XA or XD, no other values.", "nullable": true }, "Version": { "title": "String", "type": "string", "description": "One of the values in XaVersions or XdVersions.", "nullable": true }, "Edition": { "title": "String", "type": "string", "description": "MS or SS, no other values.", "nullable": true }, "DisplayName": { "title": "String", "type": "string", "description": "Display name.", "nullable": true } } }, "VersionDetail": { "title": "VersionDetail", "type": "object", "description": "Detailed VDA version information.", "additionalProperties": false, "properties": { "product": { "title": "String", "type": "string", "description": "XA or XD, no other values.", "nullable": true }, "version": { "title": "String", "type": "string", "description": "One of the values in XaVersions or XdVersions.", "nullable": true }, "edition": { "title": "String", "type": "string", "description": "MS or SS, no other values.", "nullable": true }, "displayName": { "title": "String", "type": "string", "description": "Display name.", "nullable": true } } }, "VMImageResponseModel": { "title": "VMImageResponseModel", "type": "object", "description": "Details about a virtual machine disk image used for a provisioning scheme.", "additionalProperties": false, "required": [ "ImageStatus", "Date" ], "properties": { "FunctionalLevel": { "description": "The functional level of the VDA installed in the VM.", "nullable": true, "$ref": "#/components/schemas/FunctionalLevel" }, "Image": { "description": "Reference to the VM image resource on the hypervisor.", "nullable": true, "$ref": "#/components/schemas/HypervisorResourceRefResponseModel" }, "ImageStatus": { "description": "The status of the provisioning scheme image.", "$ref": "#/components/schemas/VMImageStatus" }, "Date": { "title": "String", "type": "string", "description": "The date and time when the snapshot was used in the provisioning scheme.", "minLength": 1 }, "MasterImageNote": { "title": "String", "type": "string", "description": "The note of the provisioning scheme image.", "nullable": true } } }, "VMImageResponseModelCollection": { "title": "VMImageResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfVMImageResponseModel" }, { "type": "object", "description": "Collection of VMImageResponseModel", "additionalProperties": false } ] }, "VMImageStatus": { "title": "VMImageStatus", "type": "string", "description": "Status of a virtual machine disk image.", "x-enumNames": [ "Unknown", "Deleted", "Current", "Prepared" ], "enum": [ "Unknown", "Deleted", "Current", "Prepared" ] }, "VMInstanceType": { "title": "VMInstanceType", "type": "string", "description": "Instance type of a virtual machine.", "x-enumNames": [ "Shared", "Spot" ], "enum": [ "Shared", "Spot" ] }, "VmPriceResponseModel": { "title": "VmPriceResponseModel", "allOf": [ { "$ref": "#/components/schemas/VmSettingRequestModel" }, { "type": "object", "description": "The response object indicating the pricing information of a VM setting.", "additionalProperties": false, "properties": { "ResourcePrices": { "title": "ResourcePriceResponseModel[]", "type": "array", "description": "Gets or sets pricing information of resources.", "nullable": true, "items": { "$ref": "#/components/schemas/ResourcePriceResponseModel" } } } } ] }, "VmSettingRequestModel": { "title": "VmSettingRequestModel", "type": "object", "description": "Request object allowing caller to specify a VM setting", "additionalProperties": false, "properties": { "MachineSize": { "title": "String", "type": "string", "description": "The size of the virtual machine.", "nullable": true }, "OsType": { "description": "Specifies the operating system type of the virtual machine.", "$ref": "#/components/schemas/OsType" }, "ByoLicense": { "title": "Boolean", "type": "boolean", "description": "Whether bring your own license is enabled." }, "Location": { "title": "String", "type": "string", "description": "Specifies the location of the virtual machine.", "nullable": true }, "InstanceType": { "description": "Specifies the instance type of the virtual machine,\ntemporarily only support shared and Spot.", "$ref": "#/components/schemas/VMInstanceType" } } }, "VMToolsState": { "title": "VMToolsState", "type": "string", "description": "VM tools state", "x-enumNames": [ "Unknown", "NotPresent", "NotStarted", "Running" ], "enum": [ "Unknown", "NotPresent", "NotStarted", "Running" ] }, "VtpmProvisionPolicy": { "title": "VtpmProvisionPolicy", "type": "string", "description": "Indicates the vTPM provisioning policy of the provisioning scheme.\nOnly valid when the provisioning scheme is MCS and the machine profile has vTPM enabled.", "x-enumNames": [ "Unknown", "None", "Clone", "Clean" ], "enum": [ "Unknown", "None", "Clone", "Clean" ] }, "WakeOnLanTransmission": { "title": "WakeOnLanTransmission", "type": "string", "description": "Method of packet transmission to use for Wake-on-LAN functionality.", "x-enumNames": [ "Unknown", "None", "SubnetDirectedBroadcast", "Unicast" ], "enum": [ "Unknown", "None", "SubnetDirectedBroadcast", "Unicast" ] }, "Windows365ProvisioningType": { "title": "Windows365ProvisioningType", "type": "string", "description": "Specifies provisioning type for Windows365 Cloud PC.", "x-enumNames": [ "NotApplicable", "Dedicated", "SharedByUser", "SharedByEntraGroup" ], "enum": [ "NotApplicable", "Dedicated", "SharedByUser", "SharedByEntraGroup" ] }, "WindowsActivationType": { "title": "WindowsActivationType", "type": "string", "description": "The Windows Activation Type.", "x-enumNames": [ "UnsupportedVDA", "KeyManagementService", "MultipleActivationKey", "Unknown", "NotValid" ], "enum": [ "UnsupportedVDA", "KeyManagementService", "MultipleActivationKey", "Unknown", "NotValid" ] }, "WindowsConnectionSetting": { "title": "WindowsConnectionSetting", "type": "string", "description": "Windows connection setting.", "x-enumNames": [ "Unknown", "LogonEnabled", "Draining", "DrainingUntilRestart", "LogonDisabled" ], "enum": [ "Unknown", "LogonEnabled", "Draining", "DrainingUntilRestart", "LogonDisabled" ] }, "WonOverBy": { "title": "WonOverBy", "type": "object", "description": "The reason why a setting lost. Just the name of one of the winning policies that have this setting.", "additionalProperties": false, "properties": { "SettingName": { "title": "String", "type": "string", "description": "Name of the setting.", "nullable": true }, "PolicyName": { "title": "String", "type": "string", "description": "Name of the policy.", "nullable": true }, "GpoName": { "title": "String", "type": "string", "description": "Name of the GPO that contains the policy that uses this setting.", "nullable": true } } }, "WonOverBy2": { "title": "WonOverBy", "type": "object", "description": "The reason why a setting lost. Just the name of one of the winning policies that have this setting.", "additionalProperties": false, "properties": { "SettingName": { "title": "String", "type": "string", "description": "Name of the setting.", "nullable": true }, "WinningPolicy": { "title": "String", "type": "string", "description": "The winning policy that has this setting configured.", "nullable": true } } }, "X509ChainStatusFlags": { "title": "X509ChainStatusFlags", "type": "string", "description": "", "x-enumFlags": true, "x-enumNames": [ "NoError", "NotTimeValid", "NotTimeNested", "Revoked", "NotSignatureValid", "NotValidForUsage", "UntrustedRoot", "RevocationStatusUnknown", "Cyclic", "InvalidExtension", "InvalidPolicyConstraints", "InvalidBasicConstraints", "InvalidNameConstraints", "HasNotSupportedNameConstraint", "HasNotDefinedNameConstraint", "HasNotPermittedNameConstraint", "HasExcludedNameConstraint", "PartialChain", "CtlNotTimeValid", "CtlNotSignatureValid", "CtlNotValidForUsage", "HasWeakSignature", "OfflineRevocation", "NoIssuanceChainPolicy", "ExplicitDistrust", "HasNotSupportedCriticalExtension" ], "enum": [ "NoError", "NotTimeValid", "NotTimeNested", "Revoked", "NotSignatureValid", "NotValidForUsage", "UntrustedRoot", "RevocationStatusUnknown", "Cyclic", "InvalidExtension", "InvalidPolicyConstraints", "InvalidBasicConstraints", "InvalidNameConstraints", "HasNotSupportedNameConstraint", "HasNotDefinedNameConstraint", "HasNotPermittedNameConstraint", "HasExcludedNameConstraint", "PartialChain", "CtlNotTimeValid", "CtlNotSignatureValid", "CtlNotValidForUsage", "HasWeakSignature", "OfflineRevocation", "NoIssuanceChainPolicy", "ExplicitDistrust", "HasNotSupportedCriticalExtension" ] }, "ZonableItemType": { "title": "ZonableItemType", "type": "string", "description": "Types of zonable items.", "x-enumNames": [ "Unknown", "HypervisorConnection", "Controller", "MachineCatalog", "EdgeServer", "User", "Application" ], "enum": [ "Unknown", "HypervisorConnection", "Controller", "MachineCatalog", "EdgeServer", "User", "Application" ] }, "ZoneCriticalIssueType": { "title": "ZoneCriticalIssueType", "type": "string", "description": "The type of the zone critical issue\nRefer to https://community.citrix.com/tech-zone/learn/tech-briefs/avoid-daas-resiliency-misconfiguration/", "x-enumNames": [ "Unknown", "UnhealthyZone", "ExceedsRecommendedVdas", "LowConnectorCpuLogicalProcessors", "LowConnectorRam" ], "enum": [ "Unknown", "UnhealthyZone", "ExceedsRecommendedVdas", "LowConnectorCpuLogicalProcessors", "LowConnectorRam" ] }, "ZoneDetailResponseModel": { "title": "ZoneDetailResponseModel", "allOf": [ { "$ref": "#/components/schemas/ZoneResponseModel" }, { "type": "object", "description": "Zone detail object.", "additionalProperties": false, "properties": { "Controllers": { "title": "RefResponseModel[]", "type": "array", "description": "List of controllers in the zone.", "nullable": true, "items": { "$ref": "#/components/schemas/RefResponseModel" } } } } ] }, "ZonedItemRequestModel": { "title": "ZonedItemRequestModel", "type": "object", "description": "Request model for a zoned item.", "additionalProperties": false, "required": [ "Id", "Name", "ItemType" ], "properties": { "Id": { "title": "String", "type": "string", "description": "ID of the zoned item.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the zoned item.", "minLength": 1 }, "ItemType": { "description": "Type of the zoned item.", "$ref": "#/components/schemas/ZonableItemType" }, "AdditionalProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Additional properties of the zoned item.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } } } }, "ZonedItemResponseModel": { "title": "ZonedItemResponseModel", "type": "object", "description": "Response model for a zoned item.", "additionalProperties": false, "required": [ "Id", "Name", "ItemType" ], "properties": { "Id": { "title": "String", "type": "string", "description": "ID of the zoned item.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the zoned item.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of the zoned item.", "nullable": true }, "ItemType": { "description": "Type of the zoned item.", "$ref": "#/components/schemas/ZonableItemType" }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "Administrative scopes of the zoned item.", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "AdditionalProperties": { "title": "NameValueStringPairModel[]", "type": "array", "description": "Additional properties of the zoned item.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ZoneId": { "title": "String", "type": "string", "description": "ID of the zone which this item is in.", "nullable": true }, "ZoneName": { "title": "String", "type": "string", "description": "Name of the zone which this item is in.", "nullable": true } } }, "ZonedItemResponseModelCollection": { "title": "ZonedItemResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfZonedItemResponseModel" }, { "type": "object", "description": "Response object for collections of ZonedItemResponseModel.", "additionalProperties": false } ] }, "ZonedItemSearchRequestModel": { "title": "ZonedItemSearchRequestModel", "type": "object", "description": "Request model for defining a basic zoned item search criteria.", "additionalProperties": false, "properties": { "ZoneId": { "title": "String", "type": "string", "description": "Id of the zone in which to search for the zoned item.", "nullable": true, "example": "Id of a zone" }, "ItemType": { "description": "Type of the zoned item to search for.", "nullable": true, "example": "Type of a zoned item", "$ref": "#/components/schemas/ZonableItemType" }, "BasicSearchString": { "title": "String", "type": "string", "description": "Basic search string. Specify a string which will match if contained within name of the zoned item.", "nullable": true, "example": "Name of a zoned item" } } }, "ZonedItemsRequestModel": { "title": "ZonedItemsRequestModel", "type": "object", "description": "Request model for zoned items.", "additionalProperties": false, "properties": { "Items": { "title": "ZonedItemRequestModel[]", "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ZonedItemRequestModel" } } } }, "ZoneErrorWarningModel": { "title": "ZoneErrorWarningModel", "type": "object", "description": "The error/warning of the Zone", "additionalProperties": false, "properties": { "ZoneId": { "title": "String", "type": "string", "description": "Zone id.", "nullable": true }, "ZoneName": { "title": "String", "type": "string", "description": "Zone name.", "nullable": true }, "Category": { "description": "Indicate the category, error or warning.", "$ref": "#/components/schemas/MisConfigurationCategory" }, "Type": { "title": "String", "type": "string", "description": "The error or warning message.", "nullable": true }, "TimeInUtc": { "title": "String", "type": "string", "description": "The time of the error or warning in UTC.", "nullable": true }, "IsHighPriority": { "title": "Boolean", "type": "boolean", "description": "Indicate whether the error or warning is high priority." } } }, "ZoneNonCriticalIssueType": { "title": "ZoneNonCriticalIssueType", "type": "string", "description": "The type of the zone non-critical issue\nRefer to https://community.citrix.com/tech-zone/learn/tech-briefs/avoid-daas-resiliency-misconfiguration/", "x-enumNames": [ "Unknown", "MultipleDomainsInResourceLocation", "ExceedsHostConnectionsPerZone", "LowConnectorCountInResourceLocation", "LowConnectorCpuLogicalProcessorsPerSocket", "MissingNFuseTraffic", "MissingCtxStaTraffic", "MultipleElectedLhcBrokers", "LowConnectorCpuLogicalProcessorsForLhc", "LowConnectorRamForLhc" ], "enum": [ "Unknown", "MultipleDomainsInResourceLocation", "ExceedsHostConnectionsPerZone", "LowConnectorCountInResourceLocation", "LowConnectorCpuLogicalProcessorsPerSocket", "MissingNFuseTraffic", "MissingCtxStaTraffic", "MultipleElectedLhcBrokers", "LowConnectorCpuLogicalProcessorsForLhc", "LowConnectorRamForLhc" ] }, "ZonePreference": { "title": "ZonePreference", "type": "string", "description": "Settings for zone preference and failover.", "x-enumNames": [ "Unknown", "UserLocation", "UserHome", "UserHomeOnly", "ApplicationHome" ], "enum": [ "Unknown", "UserLocation", "UserHome", "UserHomeOnly", "ApplicationHome" ] }, "ZoneResponseModel": { "title": "ZoneResponseModel", "type": "object", "description": "Zone object.", "additionalProperties": false, "required": [ "Id", "Name", "IsPrimary" ], "properties": { "Id": { "title": "String", "type": "string", "description": "ID of the zone.", "minLength": 1 }, "Name": { "title": "String", "type": "string", "description": "Name of the zone.", "minLength": 1 }, "Description": { "title": "String", "type": "string", "description": "Description of the zone.", "nullable": true }, "Scopes": { "title": "ScopeResponseModel[]", "type": "array", "description": "Administrative scopes which the zone is part of.", "nullable": true, "items": { "$ref": "#/components/schemas/ScopeResponseModel" } }, "IsPrimary": { "title": "Boolean", "type": "boolean", "description": "Indicates whether the zone is the primary zone for the site. Resources\nin the site default to the primary zone if not set otherwise." }, "IsHealthy": { "title": "Boolean", "type": "boolean", "description": "The flag to indicate whether the zone is healthy." }, "LastStateChangeTimeInUtc": { "title": "String", "type": "string", "description": "The LastStateChangeTimeInUtc of the zone.", "nullable": true }, "Metadata": { "title": "NameValueStringPairModel[]", "type": "array", "description": "The metadata of Zone.", "nullable": true, "items": { "$ref": "#/components/schemas/NameValueStringPairModel" } }, "ResourceLocation": { "description": "Citrix Cloud resource location that corresponds to this zone.", "nullable": true, "$ref": "#/components/schemas/RefResponseModel" }, "CriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "Critical issues of the zone", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfZoneCriticalIssueType" } }, "NonCriticalIssues": { "title": "IssueModel`1[]", "type": "array", "description": "Non-Critical issues of the zone", "nullable": true, "items": { "$ref": "#/components/schemas/IssueModelOfZoneNonCriticalIssueType" } } } }, "ZoneResponseModelCollection": { "title": "ZoneResponseModelCollection", "allOf": [ { "$ref": "#/components/schemas/CollectionModelOfZoneResponseModel" }, { "type": "object", "description": "Collection of ZoneResponseMode", "additionalProperties": false } ] }, "ZonesErrorWarningModel": { "title": "ZonesErrorWarningModel", "allOf": [ { "$ref": "#/components/schemas/ErrorWarningModel" }, { "type": "object", "additionalProperties": false, "properties": { "ErrorWarning": { "title": "ZoneErrorWarningModel[]", "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ZoneErrorWarningModel" } } } } ] } }, "securitySchemes": { "BearerAuth": { "type": "apiKey", "description": "Cloud auth token", "name": "Authorization", "in": "header", "scheme": "CWSAuth", "bearerFormat": "CWSAuth Bearer=ey1..." } } }, "security": [ { "BearerAuth": [] } ] }